Message types and message format types are referred by the List Conversation Entries and Server-Sent Events Structure sections.
Message Types
| Message Type (messageType) | Description |
|---|---|
| StaticContentMessage | A message containing static content. No specific response is expected. For a sample payload, see StaticContentMessage. |
| ChoicesMessage | A message with some choices from which the recipient can choose. A response of type ChoicesResponse is expected but not required. This API doesn't cause CRM changes, such as creating and updating records, but sometimes results in conversation routing in bots. For a sample payload, see ChoicesMessage. |
| ChoicesResponseMessage | A message with the selected choices as a response to a Choices message. For a sample payload, see ChoicesResponseMessage. |
| FormMessage | A message with a form containing multiple single or multiselect choices that a recipient can choose from. A response of type FormResponse is expected but not required. For a sample payload, see FormMessage. |
| FormResponseMessage | A message with the form selection as a response to a Form message. The message results in a record being created or updated in the CRM database. For a sample payload, see FormResponseMessage. |
Format Types
Each message type supports specific format types, and each format type determines the shape of the payload.
For example, messageType StaticContentMessage supports formatType Text, RichLink, Attachments, ExternalAttachments, and WebView, If, say, messageType is StaticContentMessage and formatType is Text, the payload includes the details of the message in plain text:
"messageType": "StaticContentMessage",
"staticContent": {
"formatType": "Text",
"text": "hi"
}
This table lists all message types and their possible format types.
| Message Type (messageType) | Format Type (formatType) | Description | |
|---|---|---|---|
| StaticContentMessage | Text | Send and receive | Plain text. For a sample payload, see StaticContentMessage. |
| StaticContentMessage | RichLink | Receive | A rich link containing an inline image or video. For a sample payload, see StaticContentMessage. |
| StaticContentMessage | Attachments | Receive | Attachments stored in the CRM. Sent with MT messages. Can have optional text. For a sample payload, see StaticContentMessage. |
| StaticContentMessage | ExternalAttachments | Send | External attachments not stored in the CRM. Sent with MO messages. Can have optional text. For a sample payload, see StaticContentMessage. |
| StaticContentMessage | WebView | Receive | Web page sent. For a sample payload, see StaticContentMessage. |
| ChoicesMessage | Buttons | Receive | A text with buttons with a title. The buttons can be postbacks. For a sample payload, see ChoicesMessage. |
| ChoicesMessage | QuickReplies | Receive | An optional text with buttons that has titles and/or images. All buttons are postbacks. For a sample payload, see ChoicesMessage. |
| ChoicesMessage | Carousel | Receive | A set of items that can include images, text, and buttons. The buttons can be postbacks. For a sample payload, see ChoicesMessage. |
| ChoicesResponseMessage | Selections | Send | Selections of options from choices or forms. Always set for choice and form response. For a sample payload, see ChoicesResponseMessage. |
| FormMessage | Inputs | Receive | Sends a form from the rep side. For a sample payload, see FormMessage. |
| FormResponseMessage | Result | Send | The end user’s responses to the form sent from the rep. For a sample payload, see FormResponseMessage. |