Difference between revisions of "HTTP API/Bot Commands/sim send message"
From SmartBots Developers Docs
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
<syntaxhighlight lang="lsl"> | <syntaxhighlight lang="lsl"> | ||
| − | smartbotsAPI("sim_send_message", ["message", "Hello sim!"]); // | + | // See "LSL Helper Functions" page for this function |
| + | smartbotsAPI("sim_send_message", ["message", "Hello sim!"]); | ||
| + | |||
| + | // or for the whole estate | ||
| + | smartbotsAPI("sim_send_message", [ | ||
| + | "message", "Hello sim!", | ||
| + | "all_estates", "1" | ||
| + | ]); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 12: | Line 19: | ||
{{API Variable Group|Input}} | {{API Variable Group|Input}} | ||
{{API Variable|message|yes}} The message to send | {{API Variable|message|yes}} The message to send | ||
| + | {{API Variable|all_estates|no}} Set to TRUE (or 1) to return on all estates available for bot | ||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
Latest revision as of 18:09, 11 January 2020
Sends a message to all visitors of the sim.
// See "LSL Helper Functions" page for this function
smartbotsAPI("sim_send_message", ["message", "Hello sim!"]);
// or for the whole estate
smartbotsAPI("sim_send_message", [
"message", "Hello sim!",
"all_estates", "1"
]);
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 | = sim_send_message | ||
| 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: | ||||
| message | yes | The message to send | ||
| all_estates | optional | Set to TRUE (or 1) to return on all estates available for bot | ||
| 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
The message is being delivered to all visitors of the sim. It is visible as a separate window in viewer.
Also:
- You have to teleport to the region first.
- To execute this function your bot needs to be an Estate Manager.
- You don't need a "Sim Governor" add-on to use this function.
Examples
Teleport to DuoLife region and welcome everyone there:
// You need to adjust the vars below:
string sbApiKey = "...";
string sbBotName = "...";
string sbBotAccessCode = "...";
string myHome = "DuoLife/128/128/20";
// First, teleport to the desired region
string params = llDumpList2String([
"action=" + "teleport",
"location=" + llEscapeURL(myHome),
"apikey=" + llEscapeURL(sbApiKey),
"botname=" + llEscapeURL(sbBotName),
"secret=" + llEscapeURL(sbBotAccessCode)
], "&");
llHTTPRequest("https://api.mysmartbots.com/api/bot.html",
[HTTP_METHOD,"POST"], params);
// Then restart it:
params = llDumpList2String([
"action=" + "sim_send_message",
"message=" + llEscapeURL("Welcome to DuoLife!")
], "&");
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)
