Difference between revisions of "HTTP API/Bot Commands/group invite"
From SmartBots Developers Docs
| (One intermediate revision by the same user not shown) | |||
| Line 12: | Line 12: | ||
<!-- {{API Variable|message|no}} the message to send along with invitation (can't contain international characters) --> | <!-- {{API Variable|message|no}} the message to send along with invitation (can't contain international characters) --> | ||
{{API Variable|check_membership|no}} set to 1 if you want to '''ignore''' existing group members (see "Comments" below) | {{API Variable|check_membership|no}} set to 1 if you want to '''ignore''' existing group members (see "Comments" below) | ||
| + | {{API Variable|nosafehub|optional}}Set to 1 to ignore command if bot is currently in Linden's Safe Hub (Welcome Area). Recommended for greeters and inviters. | ||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
| Line 27: | Line 28: | ||
== Usage examples == | == Usage examples == | ||
| − | The group invitation example is available [[HTTP_API/Examples/ | + | The group invitation example is available [[HTTP_API/Examples/Sending_group_invitation|here]]. |
Latest revision as of 15:14, 25 June 2019
Sends a group invitation to a specific resident.
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_invite | ||
| 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 | ||
| roleuuid | yes | the UUID of the group role (NULL_KEY for "Everyone") | ||
| check_membership | optional | set to 1 if you want to ignore existing group members (see "Comments" below) | ||
| nosafehub | optional | Set to 1 to ignore command if bot is currently in Linden's Safe Hub (Welcome Area). Recommended for greeters and inviters. | ||
| 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
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
(Miss an API call or parameter? Submit your request in forum)
