Messages

Description

The Messages module provides access to messages exchanged within conversations. You can retrieve individual messages or lists of messages and also create new messages programmatically.

Entity Model

ExternalMessage

Field	Type	Description
`_id`	`ID`	Unique identifier of the message.
`sender`	`senderData`	Information about the sender of the message.
`conversation`	`ID`	Conversation this message belongs to.
`messageType`	`MessageType`	Type of the message (e.g., text, image, email).
`channelType`	`ChannelType`	Channel through which the message was sent (e.g., WhatsApp, Email).
`senderType`	`SenderType`	Indicates if the sender is a user, system, or bot.
`content`	`String`	Plain text content of the message.
`contentHtml`	`String`	HTML-formatted content.
`subject`	`String`	Subject of the message (mainly for email).
`emailData`	`EmailDataType`	Email-related metadata.
`commentData`	`CommentDataType`	Comment-related metadata.
`questionData`	`QuestionDataType`	Question-related metadata.
`media`	`[Media]`	Attached media (images, videos, files).
`template_cards`	`Object`	Template cards associated with the message.
`product_cards`	`Object`	Product cards included in the message.
`channelMessageId`	`String`	Identifier of the message in the external channel.
`ackStatus`	`AckType`	Delivery status acknowledgment.
`createdAt`	`Date`	Timestamp of when the message was created.
`autoCreate`	`Boolean`	Indicates if the message was auto-generated.
`failedReason`	`FailedReasonType`	Reason for delivery failure, if applicable.
`surveyData`	`surveyDataForLivechat`	Survey data for live chat interactions.
`informativeButtons`	`InformativeButtonsType`	Informative buttons included in the message.
`flowBotQuickReplyResponseId`	`String`	Identifier for flow bot quick reply response.
`flowBotQuickReplyButtonsRequired`	`Boolean`	Indicates if quick reply buttons are required.
`flowBotQuickReply`	`[FlowBotQuickReplyType]`	Flow bot quick reply options.
`quotedMessage`	`QuotedMessageType`	Reference to the quoted message, if any.
`reactions`	`ReactionEnum`	Reactions to the message.
`frontMsgId`	`String`	Frontend message ID.
`listMessage`	`ListMessageType`	List-type interactive message data.
`catalogMessage`	`CatalogInteractiveType`	Catalog message data.
`catalogOrderData`	`CatalogOrderDataType`	Order details for catalog messages.

Queries

Get Message

Use this query to get single message.

Input:

Response:

Get Message List

Use this query to get message lists for the conversation.

Input:

Response:

Mutations

Create Message

Use this mutation to create a new message

Input:

Response:

Create Message By Whatsapp

Use this mutation to create a new message by WhatsApp

Input:

Response:

Example Usage

Query Example — Get Message List

Bash (cURL)

Node.js

Mutation Example — Create Message

Bash (cURL)

Node.js

Description#

Entity Model#

ExternalMessage#

Queries#

Get Message#

Get Message List#

Mutations#

Create Message#

Create Message By Whatsapp#

Example Usage#

Query Example — Get Message List#

Mutation Example — Create Message#