Message Object

Properties
idstringRead-only

Message ID.

contentobject

Structured message content.

senderobject

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 Send Message by using the sendAs parameter.

badgesArray <Badge>maxItems 1

Optional icon and short text that give an additional detail about the message, such as the app the message was sent from or whether the message was an automated response.

Currently only 1 badge is supported.

targetChannelsArray <string>

Communication channel to send the message to.

Currently messages can be sent to 1 channel only.

sourceChannelstring
7 enum supported values:
UNKNOWN_CHANNEL_TYPECHATEMAILSMSFACEBOOKINSTAGRAMWHATSAPP

Communication channel the message is sent from.

appIdstringRead-onlyformat GUID

ID of the application that sent the message.

Omitted if the message was sent with the Chat widget.

visibilitystring
3 enum supported values:
UNKNOWN_VISIBILITYBUSINESS_AND_PARTICIPANTBUSINESS

Required. Controls who can see the message.

  • BUSINESS_AND_PARTICIPANT: Visible to the participant and site contributors.
  • BUSINESS: Visible to site contributors only.
sequenceobjectRead-only

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

directionstring
3 enum supported values:
UNKNOWN_DIRECTIONBUSINESS_TO_PARTICIPANTPARTICIPANT_TO_BUSINESS

Required. Message direction.

  • BUSINESS_TO_PARTICIPANT: The message was sent from the business to the participant.
  • PARTICIPANT_TO_BUSINESS: The message was sent from the participant to the business.
createdDatestringformat date-time

Date and time the message was sent.

Was this helpful?
Yes
No