Sign in

v2

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-071759268.3 KB
Conversations

Retrieve a Conversation

get/v3/Conversations/{id}

Path parameters

idstring required

The id of the Conversation attached to the Operator Result.

Example:conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2

The unique identifier of the conversation.

Response

Conversation object.

idstring required

The id of the Conversation attached to the Operator Result.

accountIdstring nullable required

The ID of the account that owns the Conversation.

namestring nullable required

Display name of the Conversation.

status'ACTIVE' | 'INACTIVE' | 'CLOSED' required

The status of the Conversation.

createdAtstring date-time required

Timestamp for when the Conversation was created.

updatedAtstring date-time required

Timestamp for when the Conversation was last updated.

intelligenceConfigurationIdsIntelligenceConfigurationTtid[] required

The Intelligence Configuration(s) associated with the Conversation.

conversationConfigurationIdstring required

The id of the Configuration for a Conversation.

channelsChannel[] required

The communication channel(s) included in the Conversation.

channelIdsstring[] required

The underlying channel resource ids associated with this Conversation, such as a Call ID or Message ID.

operatorResultIdsstring[] required

List of Operator Result IDs generated from this Conversation.

Example response

{
  "id": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
  "intelligenceConfigurationIds": [
    "intelligence_configuration_01k6fc25s7epm9qtk8rszbv3q5"
  ],
  "conversationConfigurationId": "conv_configuration_00000000000000000000000000",
  "participants": [
    {
      "id": "conv_participant_01k1etx3jbfx88476ccja0889c"
    }
  ],
  "communications": [
    {
      "id": "conv_communication_01k1etk2y5f1y9fpe2epfdtvv2",
      "participantId": "conv_participant_01k1etx3jbfx88476ccja0889c"
    }
  ]
}