Difference between revisions of "HTTP API/Bot Commands/status"

Revision as of 14:22, 14 October 2019

Returns the online status of the bot.

// See "LSL Helper Functions" page for this function
smartbotsAPI("status", []);

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	= 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)
	result		OK - command completed successfully FAIL - command failed
	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
	location		Current bot location if bot is online ("Region/X/Y/Z")

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

(Miss an API call or parameter? Submit your request in forum)

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE: status}}
 <onlyinclude>Returns the online status of the bot.</onlyinclude>
+<syntaxhighlight lang="lsl">
+// See "LSL Helper Functions" page for this function
+smartbotsAPI("status", []);
+</syntaxhighlight>
 {{API Variables Table}}