Message Object


Properties
appIdstringRead-onlyformat GUID

ID of the app that sent the message.

Omitted if the message was sent with the Chat widget.


badgesArray <Badge>maxItems 1

Optional icon and short text providing additional details about the message, such as the app from which the message was sent, or whether the message was an automated response.

Currently only 1 badge is supported.


contentMessageContent

Structured message content.


createdDatestringformat date-time

Date and time the message was sent.


directionstring

Required. Message direction.


idstringRead-only

Message ID.


senderIdentificationDataRead-only

ID of the message sender.

Defaults to the caller's ID using the property that matches their identity type. For 3rd-party apps, defaults to using the app's appId.

You can override the default behavior when calling the Send Message method by using the sendAs parameter.


sequencestringRead-onlyformat int64

Sequential ordering of the message.

Ensures more accurate sorting than createdDate if two messages are sent at the same time.


silentboolean

Controls whether the unread count and conversation summary are updated in the Message List.

If true, unread count and conversation summary are not updated.

Default: false


sourceChannelstringdeprecated - use sourceChannelId instead

Communication channel the message is sent from.


sourceChannelIdstringmaxLength 100

The channel ID from which the message was sent.


targetChannelIdsArray <string>maxItems 100maxLength 100

Target channel IDs to send the message to.


targetChannelsArray <string>deprecated - use targetChannelIds instead

Communication channel to send the message to.

Currently messages can be sent to 1 channel only.


visibilitystring

Required. Controls who can see the message.

Did this help?