Object

BaseMessage

Dictionary keys used in all message types.

Properties

attachments

An array of attachment dictionaries. For more information, see Attachment.

destinationId
string
(Required)

Identifies the message recipient. When the CSP receives a message from Business Chat, the value is the business ID. When the CSP sends a reply to Business Chat, the value is the customer’s opaque ID.

group
string

The group identifier for the message as specified by the business, such as the department name. For more information, see About Intent, Group, and Body Values.

id
uuid
(Required)

A UUID string that identifies the message.

intent
string

The intention, or purpose, of the chat as specified by the business, such as account_question. For more information, see About Intent, Group, and Body Values.

locale
string

Customer's device locale settings. For example, "en_AU" specifies the language as English and the region as Australia.

sourceId
string
(Required)

A string that identifies the message sender. When a customer sends a message, the source-id is the customer’s opaque ID. When a business sends a reply to the customer, the source-id is the business ID.

type
string
(Required)

A string that identifies the message type. For the list of possible values and their meanings, see Message Type Values.

v
integer
(Required)

The message payload version number. This value must be 1, which is the current version of the message JSON.

Discussion

All messages, except the /preUpload and /preDownload messages, include the fields from the BaseMessage dictionary.

See Also

Common Dictionaries

object Attachment

Dictionary keys for sending and receiving messages with attachments.