setrole
From SmartBots Developers Docs
Revision as of 15:38, 29 June 2016 by Phil (Talk | contribs) (Created page with "{{DISPLAYTITLE: setrole}} <onlyinclude>Puts member of a group in a specific role.</onlyinclude> {{API Variables Table}} {{API HTTP Required Vars|setrole|Standard bot}} {{AP...")
Puts member of a group in a specific role.
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 | = setrole | ||
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 UUID of the group | ||
roleuuid | yes | the UUID of the group role. "Everyone" role is 00000000-0000-0000-0000-000000000000 | ||
member | yes | the UUID of the avatar which should be moved to the specific role | ||
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. |
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)