How to Send Messages
There are several methods to send a message, depending on who the recipient is. Each method gets the recipient, a body and an options object.
- messages.sendToConversation(conversationId, body, options)
- messages.sendToDistributionList(distListId, body, options)
- messages.sendToGroup(groupId, body, options)
- messages.sendToGroupOfUsers([userId1, userId2, ...], body, options)
- messages.sendToRole(roleId, body, options)
- messages.sendToUser(userId, body, options)
The options object (described below) contains specific options for the method, such as group name when sending to a new group, and some generic ones:
Common Message Options
| Parameter | Type | Description |
|---|---|---|
attachmentFile | Object | A single message attachment |
attachmentFiles | ?Array<string|Object> | A list of message attachments. Currently only a single attachment is supported. |
avatarFile | File | When sending a message involves creating a group, the avatar of that group |
deleteOnRead | ?boolean | Indicates whether message should be deleted after reading (default: false) |
description | ?string | When sending a message involves creating a group, the description of that group |
escalate | ?boolean | Indicates whether message is escalated |
groupMetadata | ?Object | When sending a message involves creating a group, the metadata to supply for that group |
groupName | ?Object | When sending a message involves creating a group, the name of that group |
metadata | ?Array<Object>|?Object | An array (or single object) of message metadata objects of extra information about the message. |
organizationId | ?string | When sending a message to a user or role, which organization should have this conversation |
priority | ?string | Message priority. Values: NORMAL (default), HIGH |
senderId | ?string | ID of message sender (defaults to current user) |
ttl | ?number | Time to live in minutes. Organization settings might override this ttl. |