ATattention
Conversation

Get Conversation

Changed on

Retrieves detailed information about a specific conversation, including its transcription, participants, and metadata. The response can be customized to include or exclude certain details based on the query parameters.

get/conversations/{id}

Request

Path parameters

idstring required

Unique identifier of the conversation

Query parameters

by'id' | 'external_id'

Specify how to lookup the conversation: 'id' for internal conversation ID (default), 'external_id' for external application ID from imports

filter[include_internal_participants]boolean

Include internal participants in the response

filter[include_zoom_metadata]boolean

Include Zoom-specific metadata in the response

filter[include_import_metadata]boolean

Include import metadata in the response

filter[hide_transcript]boolean

Omit the transcript field from the response.

detailedTranscriptboolean

Include detailed transcript information in the response

Response

Successfully retrieved conversation details

type'conversations'
idstring

Example response

{
  "type": "conversations",
  "id": "conv-uuid-123",
  "attributes": {
    "uuid": "conv-uuid-123",
    "title": "Q1 Deal Review - Acme Corp",
    "createdAt": "2024-03-18T10:00:00Z",
    "finishedAt": "2024-03-18T10:45:00Z",
    "liveStreamStartedAt": "2024-03-18T10:00:00Z",
    "liveStreamEndedAt": "2024-03-18T10:45:00Z",
    "userUUID": "user-uuid-456",
    "teamUUID": "team-uuid-789",
    "archived": false,
    "referenceable": true,
    "private": false,
    "isInternal": false,
    "isEmpty": false,
    "mediaDuration": 2700,
    "videoUID": "vid-uid-abc",
    "videoStatus": "ready",
    "mediaStorageStatus": "ready",
    "transcriptStatus": "completed",
    "crmExportStatus": "exported",
    "importStatus": "completed",
    "dealUUID": "deal-uuid-xyz",
    "emailTemplateID": "",
    "externalIntelligenceOpportunityID": "opp-ext-123",
    "zoomMeetingJoinUrl": "",
    "googleMeetJoinUrl": "",
    "microsoftTeamsJoinUrl": "",
    "webexJoinUrl": "",
    "transcript": {},
    "participants": [
      {
        "id": "part-uuid-1",
        "email": "jane@example.com",
        "name": "Jane Smith",
        "organizer": true,
        "status": "accepted"
      },
      {
        "id": "part-uuid-2",
        "email": "john@customer.com",
        "name": "John Doe",
        "organizer": false,
        "status": "accepted"
      }
    ],
    "attendees": [
      {
        "id": "part-uuid-1",
        "email": "jane@example.com",
        "name": "Jane Smith",
        "organizer": true,
        "status": "accepted"
      }
    ],
    "bots": [
      {
        "uuid": "bot-uuid-1",
        "meetingUrl": "https://zoom.us/j/1234567890",
        "status": {
          "code": "completed",
          "message": "Recording uploaded",
          "createdAt": "2024-03-18T10:50:00Z"
        }
      }
    ],
    "boards": [
      {
        "uuid": "cb-uuid-1",
        "board": {
          "uuid": "board-uuid-1",
          "name": "Sales Playbook",
          "teamUUID": "team-uuid-789",
          "columns": []
        },
        "battlecards": []
      }
    ],
    "talktracks": [
      {
        "uuid": "ct-uuid-1",
        "items": [
          {
            "uuid": "cti-uuid-1",
            "activatedItemId": "item-uuid-1",
            "done": true
          }
        ]
      }
    ],
    "scorecardResults": [
      {
        "uuid": "sr-uuid-1",
        "title": "Sales Discovery Scorecard",
        "items": [],
        "summary": {
          "averageScore": 85,
          "min": 0,
          "max": 100,
          "summaryText": "Good performance"
        }
      }
    ],
    "externalOpportunity": {
      "uuid": "opp-uuid-456",
      "title": "Enterprise Deal - Acme Corp"
    },
    "importMetadata": {},
    "linkedCrmRecords": [
      {
        "id": "001ABC123",
        "code": "Account"
      }
    ],
    "externalAccounts": [
      {
        "id": "001ACC456",
        "code": "Account"
      }
    ],
    "externalContacts": [
      {
        "id": "003CON789",
        "code": "Contact"
      }
    ],
    "extractedIntelligence": {},
    "confirmedExtractedIntelligence": {},
    "labels": {},
    "labelTagsToFilterIfNA": [],
    "deprecatedLabelCategories": []
  },
  "links": {
    "self": "/v2/conversations/conv-uuid-123"
  }
}

Changes

  • cda9523b5c97Revision changes
    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/vnd.api+json)

  • 73b58a6d314aRevision changes
    • info

      added the new optional query request parameter filter[hide_transcript]