HTTP API/Bot Commands/im

From SmartBots Developers Docs
HTTP APIBot Commands
Revision as of 07:38, 29 June 2016 by Phil (Talk | contribs) (Created page with "<onlyinclude>Sends an Instant Message to a specific user.</onlyinclude> {{API Variables Table}} {{API HTTP Required Vars|im}} {{API Variable Group|Input}} {{API Variable|sln...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Sends an Instant Message to a specific user.

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

Example

Send Instant Message to Tester Resident:

string recipient="Tester Resident";

string params = llDumpList2String([
  "action="  + "im",
  "apikey="  + llEscapeURL(sbApiKey),
  "botname=" + llEscapeURL(sbBotName),
  "secret="  + llEscapeURL(sbBotAccessCode),
  "slname="  + llEscapeURL(recipient),
  "message=" + llEscapeURL("Hello there!")
  ], "&");
 
llHTTPRequest("http://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)