Messages

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:

COMMENT message type requirements:

When msgType is COMMENT, this mutation replies to an existing comment message. It does not create a standalone comment record. The existing message is updated with reply information in commentData.

Field	Description
`msgType`	Must be `COMMENT`.
`msgId`	Qpien internal `_id` of the original comment message to reply to.
`sender`	Customer person / agent `_id` that sends the reply.
`content`	Reply text that will be sent to the external platform.
`convId`	Conversation `_id` that contains the original comment message.
`pChannelId`	Person channel `_id` for the customer/person in the conversation.
`channelId`	Connected platform/channel `_id`.
`channelType`	Channel type, for example `INSTAGRAM`.
`isTicket`	Set to `false` unless the reply is part of a ticket flow.

Important: msgId must be the internal message _id, not the platform channelMessageId.

PRIVATE_REPLY message type requirements:

When msgType is PRIVATE_REPLY, this mutation sends a private message reply for an existing public comment message. The target comment message is updated with private-reply information in commentData, and the created message is returned with messageType: PRIVATE_REPLY.

Field	Description
`msgType`	Must be `PRIVATE_REPLY`.
`msgId`	Qpien internal `_id` of the original comment message to privately reply to.
`sender`	Customer person / agent `_id` that sends the private reply.
`content`	Private reply text that will be sent to the external platform.
`convId`	Conversation `_id` that contains the original comment message.
`pChannelId`	Person channel `_id` for the customer/person in the conversation.
`channelId`	Connected platform/channel `_id`.
`channelType`	Supported channel type: `FACEBOOK`, `INSTAGRAM`, or `TIKTOK`.
`isTicket`	Set to `false` unless the private reply is part of a ticket flow.

Important: msgId must be the internal message _id of an existing COMMENT message, not the platform channelMessageId. Only one private reply can be sent for a comment.

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

Mutation Example — Create Comment Reply Message

Use externalCreateMessage with msgType: "COMMENT" to reply to an existing comment message. The msgId value must be the Qpien internal _id of the original comment message.

Bash (cURL)

Node.js

Mutation Example — Create Private Reply Message

Use externalCreateMessage with msgType: "PRIVATE_REPLY" to send a private reply to an existing public comment message. The msgId value must be the Qpien internal _id of the original comment 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#

Mutation Example — Create Comment Reply Message#

Mutation Example — Create Private Reply Message#

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

Mutation Example — Create Comment Reply Message

Mutation Example — Create Private Reply Message