im
From SmartBots Developers Docs
(Redirected from HTTP API/Bot Commands2/im)
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 |
or
| ||
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)