Conversations

Description

The Conversations module allows external applications to retrieve, update, and manage customer conversations. A conversation can include multiple participants, messages, tags, and ticket-related metadata. This module is central to handling customer support or communication workflows.

Entity Model

ExternalConversation

Field	Type	Description
`_id`	`ID`	Unique identifier of the conversation.
`customer`	`ID`	The associated customer ID.
`joinedPerson`	`ID`	The person who joined the conversation.
`joinedCPerson`	`ID`	The customer-side person currently joined.
`isStarred`	`Boolean`	Whether the conversation is marked as important.
`status`	`ConversationStatusEnum`	Current status of the conversation.
`isGroupOrChannel`	`Boolean`	Whether the conversation is a group/channel.
`lastMessage`	`LastMessageType`	The last message sent in the conversation.
`lastReceivedMessageChannel`	`ID`	Channel ID of the last received message.
`tags`	`[Tag]`	List of tags assigned to the conversation.
`channels`	`[ChannelTypeOutput]`	Channels linked to the conversation.
`type`	`ConversationTypeEnum`	Type of conversation (direct, group, etc.).
`priority`	`TicketPriority`	Priority level of the conversation.

Queries

Get Conversation

Use this query to get conversation details.

Input:

Response:

Get Conversation List

Use this query to get conversation list.

Input:

Response:

Mutations

Update Conversation

Use this mutation to update the conversation

Input:

Response:

Example Usage

Query Example — Get Conversation

Bash (cURL)

Node.js

Mutation Example — Update Conversation

Bash (cURL)

Node.js

Description#

Entity Model#

ExternalConversation#

Queries#

Get Conversation#

Get Conversation List#

Mutations#

Update Conversation#

Example Usage#

Query Example — Get Conversation#

Mutation Example — Update Conversation#