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

From SmartBots Developers Docs
Jump to: navigation, search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE: im (HTTP Bot Command)}}
+
{{DISPLAYTITLE: im}}
 
<onlyinclude>Sends an Instant Message to a specific user.</onlyinclude>
 
<onlyinclude>Sends an Instant Message to a specific user.</onlyinclude>
 +
 +
<syntaxhighlight lang="lsl">
 +
// See "LSL Helper Functions" page for this function
 +
smartbotsAPI("im", [
 +
  "slname", "Glaznah Gassner",
 +
  "message", "Hello in-world!"
 +
]);
 +
</syntaxhighlight>
  
 
{{API Variables Table}}
 
{{API Variables Table}}
Line 6: Line 14:
  
 
{{API Variable Group|Input}}
 
{{API Variable Group|Input}}
{{API Variable|slname|yes}} Second Life login name of avatar
+
{{API Variable|slname|yes}}
 +
* Second Life login name of avatar
 +
or
 +
* avatar UUID
 
{{API Variable|message|yes}} The message to send
 
{{API Variable|message|yes}} The message to send
 +
{{API Variable|nosafehub|optional}}Set to 1 to ignore command if bot is currently in Linden's Safe Hub (Welcome Area). Recommended for greeters and inviters.
  
 
{{API Variable Group|Output}}
 
{{API Variable Group|Output}}
Line 17: Line 29:
 
Send Instant Message to Tester Resident:
 
Send Instant Message to Tester Resident:
  
<syntaxhighlight lang="lsl">
+
{{API HTTP Example Boilerplate}}
string recipient="Tester Resident";
+
  
string params = llDumpList2String([
+
<syntaxhighlight lang="lsl">
  "action=" + "im",
+
smartbotsAPI("im", [
  "apikey="  + llEscapeURL(sbApiKey),
+
   "slname", "Tester Resident",
  "botname=" + llEscapeURL(sbBotName),
+
   "message", "Hello from bot!"
   "secret=" + llEscapeURL(sbBotAccessCode),
+
]);
  "slname=" + llEscapeURL(recipient),
+
   "message=" + llEscapeURL("Hello there!")
+
  ], "&");
+
+
llHTTPRequest("http://api.mysmartbots.com/api/bot.html",
+
  [HTTP_METHOD,"POST"], params);
+
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Latest revision as of 15:13, 25 June 2019

Sends an Instant Message to a specific user.

// See "LSL Helper Functions" page for this function
smartbotsAPI("im", [
  "slname", "Glaznah Gassner",
  "message", "Hello in-world!"
]);

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 = im
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:
slname yes
  • Second Life login name of avatar

or

  • avatar UUID
message yes The message to send
nosafehub optional Set to 1 to ignore command if bot is currently in Linden's Safe Hub (Welcome Area). Recommended for greeters and inviters.
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.

Example

Send Instant Message to Tester Resident:

(the example uses smartbotsAPI() helper function. Set your "apikey", "botname" and "secret" in that function)

smartbotsAPI("im", [
  "slname", "Tester Resident",
  "message", "Hello from bot!"
]);


<< return back to Bot commands

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