login
From SmartBots Developers Docs
(Redirected from HTTP API/Bot Commands2/login)
Initiates bot login 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 | = login | ||
| 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: | ||||
| location | optional | The initial location to login. Leave blank for previous location.
Format (one of):
This value replaces bot base location ("Bot base location" in Bot Control Panel). Setting this value also sets "login to: base location". | ||
| siton | optional | The UUID of the object bot will try to sit on once logged in (same as "Object to sit" in Bot Control Panel). | ||
| 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 in. It is always successful:
- you won't get any error if the bot is already logged in
- you won't get any error if the bot's password is incorrect
You can use set_http_callback command to receive HTTP notification of bot being logged in/out.
Example
Login your bot immediately (the command is ignored if bot is already logged in). Bot logs in to DuoLife region:
string recipient="Tester Resident";
string params = llDumpList2String([
"action=" + "login",
"apikey=" + llEscapeURL(sbApiKey),
"botname=" + llEscapeURL(sbBotName),
"secret=" + llEscapeURL(sbBotAccessCode),
"location=" + llEscapeURL("DuoLife/206/36/94")
], "&");
llHTTPRequest("https://api.mysmartbots.com/api/bot.html",
[HTTP_METHOD,"POST"], params);
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
