From SmartBots Developers Docs
Jump to: navigation, search

Sends a group invitation to a specific resident.


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_invite
apikey yes Your personal developer's API key.
botname yes Your bot's SL login.
secret yes Bot access code of your bot.
custom no 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
roleuuid yes the UUID of the group role (NULL_KEY for "Everyone")
check_membership no set to 1 if you want to ignore existing group members (see "Comments" below)
result OK - command completed successfully
FAIL - command failed
resulttext Detailed reason for the failure.
custom The value from input "custom" parameter. See above.


Ignoring existing group members

It is possible to ignore existing group members and do not invite them: set check_membership parameter to 1.

Important notice: bot reloads the list of the group members every 10 minutes. Thus, if resident (1) exits from the group and then (2) tries to join back immediately, bot will think that resident still in the group: the invitation will be discarded.

Usage examples

The group invitation example is available here.

<< return back to Bot commands