group_info
From SmartBots Developers Docs
Revision as of 14:32, 21 October 2019 by Gg (Talk | contribs) (Created page with "{{DISPLAYTITLE: group_info}} <onlyinclude>Returns the information about Second Life group.</onlyinclude> <syntaxhighlight lang="lsl"> // See "LSL Helper Functions" page for t...")
Returns the information about Second Life group.
// See "LSL Helper Functions" page for this function
smartbotsAPI("group_info", [
"groupuuid": "0b65a122-8f77-64fe-5b2a-225d4c490d9c"
]);
Variables
The following table shows input values (you send them with the API call) and returned output values.
Variable | Required | Description | ||
---|---|---|---|---|
Input basic parameters: | ||||
action | yes | = group_info | ||
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: | ||||
groupuuid | yes | the group UUID | ||
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. | |||
charter | Group text | |||
insignia | Group profile image UUID | |||
fee | Group join fee | |||
founder | Founder avatar UUID | |||
mature | "1" if group has a Mature flag | |||
members | The number of members | |||
member_title | The default member tag | |||
name | Group name | |||
open | "1" if group is open to join | |||
uuid | Group UUID |
Limitations
This API command is not intended for a mass group parsing. Thus, repetitive requests (roughly more than 3 per 10 seconds) may be throttled.
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)