group_eject
From SmartBots Developers Docs
Revision as of 15:35, 29 June 2016 by Phil (Talk | contribs) (Created page with "{{DISPLAYTITLE: group_eject}} <onlyinclude>Ejects residents from the group.</onlyinclude> {{API Variables Table}} {{API HTTP Required Vars|group_eject|Standard bot}} {{API...")
Ejects residents from the group.
Variables
The following table shows input values (you send them with the API call) and returned output values.
Variable | Required | Description | ||
---|---|---|---|---|
This API command applies only for Standard bot | ||||
Input basic parameters: | ||||
action | yes | = group_eject | ||
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: | ||||
avatar | yes | the UUID of the resident | ||
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. |
Important
If you are using a custom role (other than "Everyone") you need an additional abilities for your bot. Read this for details.
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)