status
Returns the online status of the bot.
// See "LSL Helper Functions" page for this function
smartbotsAPI("status", []);Variables
The following table shows input values (you send them with the API call) and returned output values.
Input basic parameters
Variable | Required | Description |
|---|---|---|
action | yes | = status |
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)
Variable | Description |
|---|---|
result | OK - command completed successfully |
resulttext | Detailed reason for the failure. |
custom | The value from input "custom" parameter. See above. |
status | Current online status of the bot (see "Details") |
online | "1" if bot is online, "0" otherwise |
slname | Full SL name of the bot |
uuid | Bot avatar UUID |
location | Current bot location if bot is online ("Region/X/Y/Z") |
Details
The following statuses can be returned:
ONLINE - the bot is online
PRE-CONNECTING - the bot is going to log in and waits for a SL login server response
CONNECTING - SL login server logs the bot in
LOGGED OUT - bot is logged out now (gracefully, by the owner's command)
OFFLINE - bot can not be contacted. This is an unexpected behavior and usually happens while SmartBots servers are restarting
Example
For the usage example script see Get bot status example.