Difference between revisions of "HTTP API/Bot Commands/listgroups"

From SmartBots Developers Docs
Jump to: navigation, search
 
Line 2: Line 2:
 
<onlyinclude>Returns a list of the Second Life groups the bot is member of.</onlyinclude>
 
<onlyinclude>Returns a list of the Second Life groups the bot is member of.</onlyinclude>
  
If you need to list groups of another avatar, use [[avatar_groups (HTTP Bot Command)|avatar_groups]] command.
+
If you need to list groups of another avatar, use [[HTTP API/Bot Commands/avatar_groups|avatar_groups]] command.
  
 
{{API Variables Table}}
 
{{API Variables Table}}

Latest revision as of 09:56, 30 June 2016

Returns a list of the Second Life groups the bot is member of.

If you need to list groups of another avatar, use avatar_groups command.

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 = listgroups
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.
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.
groups The list of the group uuids and names, separated by a new-line ("\n")

Example

The groups list is being returned in the following format:

groups=d175f82a-2e8a-bcd2-af0b-8012d0678f2d%3B
Gems %26 Kisses%0A040f0cd7-254e-582c-8ef7-bc90
57d6834e%3BI Love Full Moon%0A5a4a72f5-ba47-4d
bb-48d3-ebd030148ba2%3BIllusionz Nightclub

after unescaping routine:

d175f82a-2e8a-bcd2-af0b-8012d0678f2d;Gems & Kisses
040f0cd7-254e-582c-8ef7-bc9057d6834e;I Love Full Moon
5a4a72f5-ba47-4dbb-48d3-ebd030148ba2;Illusionz Nightclub


<< return back to Bot commands

(Miss an API call or parameter? Submit your request in forum)