From SmartBots Developers Docs
Jump to: navigation, search

Ejects residents from the group.


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.
avatar yes the UUID of the resident
groupuuid yes the UUID of the group
ignore_membership optional set to 1 to return success even if resident is not in the group (see "Return value" below)
(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.

Return value

By default, the command returns success ("OK") when resident has been successfully ejected. Thus, if resident was not a member of the group, the error "Ejectee is not in the group" will be returned.

If you don't care if resident actually was a member before, use **ignore_membership** parameter (set it to 1).

Custom roles

If your member has 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)