From SmartBots Developers Docs
Jump to: navigation, search

Returns a list the roles in given group.


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 = list_group_roles
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.
groupuuid yes the UUID of the group
result OK - command completed successfully
FAIL - command failed
resulttext Detailed reason for the failure.
custom The value from input "custom" parameter. See above.
roles The list of the role uuids and names, separated by a new-line ("\n")


The roles list is being returned in the following format:

roles=044ad014-7298-eb70-0945-85d6df01f154%3BOwners%0A10d7e54f-7c52-8f0e-7ad8-7e0059664cd0%3BSmartBots%0Aaebb8d51-c3b6-74cb-cc66-9c30584b5542%3BAlive Bots%0Aaef5b7a6-f0c4-b847-5953-1d490f0b3485%3BSupport Bot%0Aeaa86b3b-1408-fb4f-3118-7dadabf65fec%3BPersonal bot%0A00000000-0000-0000-0000-000000000000%3BEveryone

Roles after unescaping routine:

aebb8d51-c3b6-74cb-cc66-9c30584b5542;Alive Bots
aef5b7a6-f0c4-b847-5953-1d490f0b3485;Support Bot
eaa86b3b-1408-fb4f-3118-7dadabf65fec;Personal bot

<< return back to Bot commands