Difference between revisions of "HTTP API/Bot Commands/group join"
From SmartBots Developers Docs
m (Phil moved page HTTP API: Bot Commands/group join to HTTP API/Bot Commands2/group join) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE: group_join | + | {{DISPLAYTITLE: group_join}} |
<onlyinclude>Tries to join a group by UUID.</onlyinclude> | <onlyinclude>Tries to join a group by UUID.</onlyinclude> | ||
| Line 21: | Line 21: | ||
{{HTTP API Bot - standard footer}} | {{HTTP API Bot - standard footer}} | ||
| + | |||
| + | |||
| + | {{NavMenu}} | ||
| + | |||
| + | __NOTOC__ | ||
Latest revision as of 15:14, 29 June 2016
Tries to join a group by UUID.
Variables
The following table shows input values (you send them with the API call) and returned output values.
| Variable | Required | Description | ||
|---|---|---|---|---|
| Input basic parameters: | ||||
| action | yes | = group_join | ||
| apikey | yes | Your personal developer's API key. | ||
| botname | yes | Your bot's SL login. | ||
| secret | yes | Bot access code of your bot. | ||
| dataType | optional | Set to "json" to get JSON reply instead of URL-encoded string | ||
| custom | optional | The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response. | ||
| Input: | ||||
| groupuuid | yes | the UUID of the group | ||
| Output: | ||||
| (to be received in http_response LSL event, see docs for details) | ||||
| result | OK - command completed successfully FAIL - command failed | |||
| resulttext | Detailed reason for the failure. | |||
| custom | The value from input "custom" parameter. See above. | |||
Comments
- The group enrollment should be open for the bot to be able to join.
- Group can be hidden from SL search.
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
