group_invite

Sends a group invitation to a specific resident.

This API command applies only for Standard bots.

// See "LSL Helper Functions" page for this function
smartbotsAPI("group_invite", [
  "avatar", "417732f0-a100-4e2d-a9bf-e381cfd12c3a",
  "groupuuid", "0b65a122-8f77-64fe-5b2a-225d4c490d9c",
  "roleuuid", "00000000-0000-0000-0000-000000000000"
]);

Variables

The following table shows input values (you send them with the API call) and returned output values.

Input basic parameters

Variable	Required	Description
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

Variable	Required	Description
avatar	yes	The UUID of the resident to invite
groupuuid	yes	The UUID of the group to invite the resident to
roleuuid	yes	The UUID of the group role (use `NULL_KEY` for “Everyone”)
check_membership	optional	Set to `1` to ignore existing group members (see Comments below)
nosafehub	optional	Set to `1` to ignore the command if the bot is currently in a Linden Safe Hub (Welcome Area). Recommended for greeters and inviters.

Output

(To be received in *http_response* LSL event, see docs for details)

Variable	Description
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

To skip inviting users who are already group members, set check_membership to 1.

The bot reloads the list of group members every 10 minutes.
If a resident leaves a group and tries to rejoin immediately, the bot may still think the resident is a member, causing the invitation to be discarded.

Usage examples

A detailed example of group invitation usage is available here.