logout (HTTP Bot Command)
From SmartBots Developers Docs
Revision as of 13:05, 29 June 2016 by Phil (Talk | contribs) (Phil moved page HTTP API/Bot Commands2/logout to HTTP API/Bot Commands/logout)
Initiates bot logout sequence.
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 | = logout | ||
| 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. | |||
Comments
This commands just tells the bot to start logging out. It is always successful:
- you won't get any error if the bot is already logged out
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
