This method allows an app to send a message to a user or a group.
The method endpoint is https://api.flock.co/v1/chat.sendMessage
and follows the method calling conventions.
Parameters
Name | Type | Required | Description |
---|---|---|---|
token | String | Yes | Token of the user on whose behalf the message is being sent |
to | String | Yes | Identifier of the user to whom the message is to be sent |
text | String | Yes | Text of the message |
flockml | String | No | FlockML alternative to message text. If present this will be shown instead of message text. |
notification | String | No | Notification to be shown for the message. If not present, text is used for the notification. |
mentions | Array | No | An array of user identifiers indicating users who have been mentioned in the message. |
sendAs | SendAs | No | Use this field if you want to display another name and image as the sender. |
attachments | Array | No | An array of attachments. Any rich content to be included with the message is sent as an attachments. |
onBehalfOf | String | No | Needed when a bot sends a message to a channel. Set its value to the id of the user on whose behalf the bot is sending a message. See how bots can send a message to a channel. |
visibleTo | Array | No | Use this to display the message to a limited number of members in a channel. Its value should be an array of user ids. |
SendAs
The attributes of the sendAs
field are as follows:
Name | Type | Required | Description |
---|---|---|---|
name | String | Yes | Name of the sender. |
profileImage | String | Yes | URL of the sender's profile image. |
Response
The uid
of the message.
{ "uid": "d9e054e0-a679-4a7a-9cfa-7299669aa083" }
Errors
Error Code | HTTP Status | Description | Additional Parameters |
---|---|---|---|
UnknownRecipient | 400 | The recipient of the message in the to field is unknown | |
MissingTextOrAttachment | 400 | The message contains neither text nor any attachment |