Difference between revisions of "HTTP API/Bot Commands/logout"
From SmartBots Developers Docs
m (Phil moved page HTTP API/Bot Commands2/logout to HTTP API/Bot Commands/logout) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE: logout | + | {{DISPLAYTITLE: logout}} |
<onlyinclude>Initiates bot logout sequence.</onlyinclude> | <onlyinclude>Initiates bot logout sequence.</onlyinclude> | ||
| Line 17: | Line 17: | ||
{{HTTP API Bot - standard footer}} | {{HTTP API Bot - standard footer}} | ||
| + | |||
| + | {{NavMenu}} | ||
| + | |||
| + | __NOTOC__ | ||
Latest revision as of 15:15, 29 June 2016
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)
