Retrieving a Conversation

This endpoint allows you to retrieve detailed information about a specific conversation using its unique identifier.

Path Parameters

Parameter	Type	Description
conversationId	string (UUID)	The unique identifier of the conversation you want to retrieve

Response Structure

The response includes comprehensive details about the conversation, including:

Basic conversation details (ID, type, status)
Timing information (start time, end time)
Phone numbers and routing information
Post-call data and metadata
Dynamic variables used during the conversation

Example Request

Here’s an example of how to retrieve a conversation:

curl --request GET \
  --url https://www.oration.ai/api/v2/conversations/a7cc5115-fe5c-4a6a-3428-123b39ac8dd3 \
  --header 'x-api-key: your-api-key-here' \
  --header 'x-workspace-id: your-workspace-id-here'

Example Response

{
    "id": "a7cc5115-fe5c-4a6a-3428-123b39ac8dd3",
    "phoneId": null,
    "agentId": "3e3132c1-700e-40e8-9b10-9fbd538f28c2",
    "workspaceId": "c9baa2e8-a75a-4203-8f64-45f232430926",
    "wsUrl": null,
    "llmUrl": null,
    "callStartTime": "2025-01-21T08:55:01.709Z",
    "callEndTime": "2025-01-21T08:55:55.333Z",
    "userJoinTime": null,
    "userLeaveTime": "2025-01-21T08:55:55.333Z",
    "customerId": "f8a70f62-d1ce-4860-8f1d-dce3ccdbbaab",
    "toPhoneNumber": "+911234123412",
    "fromPhoneNumber": null,
    "conversationStatus": "completed",
    "telephonyType": "outbound",
    "telephonyStatus": null,
    "endReason": "user_did_not_answer",
    "recordingStatus": null,
    "postCallNotes": null,
    "postCallCategory1": null,
    "postCallCategory2": null,
    "postCallCategory3": null,
    "postCallMetadata": null,
    "conversationType": "telephony",
    "dynamicVariables": "{\"customerName\":\"Alice Smith\",\"productName\":\"Gold Membership\"}",
    "summary": "",
    "createdAt": "2025-01-21T08:55:00.398Z",
    "updatedAt": "2025-01-21T08:55:00.398Z"
}

Error Responses

404 Not Found

{
  "message": "Conversation not found or access denied",
  "code": "NOT_FOUND",
  "data": {
    "code": "NOT_FOUND",
    "httpStatus": 404,
    "path": "workspaces.conversation.getById",
    "zodError": null
  }
}

401 Unauthorized

{
  "message": "User Not Found",
  "code": "UNAUTHORIZED",
  "data": {
    "code": "UNAUTHORIZED",
    "httpStatus": 401,
    "path": "workspaces.conversation.getById",
    "zodError": null
  }
}

Tips for Using the Get Conversation Endpoint

Store Conversation IDs: Always store the conversation IDs returned from the create conversation endpoint if you plan to retrieve them later.
Error Handling: Implement proper error handling for cases where the conversation might not exist or the API key is invalid.
Timestamps: All timestamp fields are returned in ISO 8601 format with UTC timezone.

API Documentation

Conversations

Jobs

Customers

Tickets

Get Conversation

Retrieving a Conversation

Path Parameters

Response Structure

Example Request

Example Response

Error Responses

404 Not Found

401 Unauthorized

Tips for Using the Get Conversation Endpoint

​Retrieving a Conversation

​Path Parameters

​Response Structure

​Example Request

​Example Response

​Error Responses

​404 Not Found

​401 Unauthorized

​Tips for Using the Get Conversation Endpoint

Retrieving a Conversation

Path Parameters

Response Structure

Example Request

Example Response

Error Responses

404 Not Found

401 Unauthorized

Tips for Using the Get Conversation Endpoint