send_group_im
From SmartBots Developers Docs
Revision as of 15:36, 29 June 2016 by Phil (Talk | contribs) (Created page with "{{DISPLAYTITLE: send_group_im}} <onlyinclude>Sends a message to group chat.</onlyinclude> {{API Variables Table}} {{API HTTP Required Vars|send_group_im|Standard bot}} {{AP...")
Sends a message to group chat.
Variables
The following table shows input values (you send them with the API call) and returned output values.
| Variable | Required | Description | ||
|---|---|---|---|---|
| This API command applies only for Standard bot | ||||
| Input basic parameters: | ||||
| action | yes | = send_group_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: | ||||
| groupuuid | yes | the UUID of the group | ||
| message | yes | the text to send (can contain international characters) | ||
| 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
- This command does not return FAIL if your bot has no "Join Group Chat" ability. Pay attention to the bot's group permissions while using this command.
- The message delivery is guaranteed even if bot is offline (the message will be sent when bot comes online)
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
