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

Revision as of 19:16, 4 March 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!"
]);

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
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.

Send Instant Message to Tester Resident:

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

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

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

@@ Line 31: / Line 31: @@
 <syntaxhighlight lang="lsl">
-string recipient="Tester Resident";
+// See "LSL Helper Functions" page for this function
+smartbotsAPI("im", [
-string params = llDumpList2String([
+   "slname", "Glaznah Gassner",
-  "action="  + "im",
+   "message", "Hello in-world!"
-   "apikey="  + llEscapeURL(sbApiKey),
+]);
-  "botname=" + llEscapeURL(sbBotName),
-   "secret="  + llEscapeURL(sbBotAccessCode),
-  "slname="  + llEscapeURL(recipient),
-  "message=" + llEscapeURL("Hello there!")
-  ], "&");
-llHTTPRequest("https://api.mysmartbots.com/api/bot.html",
-  [HTTP_METHOD,"POST"], params);
 </syntaxhighlight>