​
Get Call Details API

Retrieve detailed information about a specific call including its transcript, evaluation metrics, and metadata.

​
API Endpoint

MethodEndpoint
GEThttps://new-prod.vocera.ai/observability/v1/call-logs-external/:call_log_id/

​
Authentication

Include your API key in the request headers:

HeaderDescription
X-VOCERA-API-KEYYour API key obtained from the dashboard

​
Path Parameters

ParameterTypeRequiredDescription
call_log_idintegerYesUnique identifier of the call log

​
Response Format

The API returns detailed information about the specified call.

​
Response Properties

PropertyTypeDescription
idintegerUnique identifier for the call
voice_recording_urlstringURL to access the call recording
durationstringDuration of the call in HH:MM format
timestampstringISO 8601 timestamp of when the call occurred
successbooleanWhether the call was successful, null means evaluation is pending
transcriptstringPlain text transcript of the call
transcript_objectarrayJSON transcript of the call
evaluationobjectCall evaluation metrics and scores
call_ended_reasonstringReason for call termination
customer_numberstringCustomer’s phone number
metadataobjectAdditional call metadata
call_idstringReference identifier for call (for example from Vapi, Retell or your system)
agentintegerID of the agent handling the call

​
Evaluation Metrics Object

PropertyTypeDescription
idintegerMetric identifier
namestringName of the metric
typestringType of metric (binary_workflow_adherence, binary_qualitative, continuous_qualitative, numeric, enum)
scorenumberScore achieved for the metric (out of 5 for binary_workflow_adherence, binary_qualitative and continuous_qualitative)
enumstringValue selected from predefined options (only present for enum type metrics)
explanationarray|stringDetailed explanation of the score
vocera_defined_metric_codestringPredefined metric code if applicable

​
Example Response

{
    "id": 413,
    "voice_recording_url": "https://example.com/recording.wav",
    "duration": "00:10",
    "timestamp": "2024-12-03T11:05:47.571279Z",
    "success": true,
    "evaluation": {
        "metrics": [
            {
                "id": 2,
                "name": "Call Pickup",
                "type": "binary_workflow_adherence",
                "score": 5,
                "explanation": [
                    "1. List key points from the transcript relevant to the metric:",
                    "   - The call was picked up successfully"
                ],
                "vocera_defined_metric_code": "xyz"
            }
        ]
    },
    "transcript": "[0:01] Testing Agent: Hello.\n[0:03] Main Agent: Hello...",
    "transcript_object": [
        // Transcript object array shown below
    ],
    "call_ended_reason": "NORMAL_COMPLETION",
    "customer_number": "+1234567890",
    "metadata": {
        "customer_id": "cust_123",
        "department": "sales",
        "priority": "high"
    },
    "call_id": "call_5otWH44dxeXEHY8RlhYYaFbV",
    "agent": 789
}

Transcript JSON Example:

[
   {
      "role": "Testing Agent",
      "time": "0:01",
      "content": "Hello.",
      "end_time": 1.9399999,
      "start_time": 1.4399999
   },
   {
      "role": "Main Agent",
      "time": "0:03",
      "content": "Hello. I want to book appointment today. My name is John.",
      "end_time": 7.539999511718751,
      "start_time": 3.1
   },
   {
      "role": "Testing Agent",
      "time": "0:12",
      "content": "Well, I mean, sure. What time exactly are we talking about here",
      "end_time": 15.71,
      "start_time": 12.01
   },
   {
      "role": "Main Agent",
      "time": "0:17",
      "content": "6 PM.",
      "end_time": 18.269999,
      "start_time": 17.609999
   },
   {
      "role": "Testing Agent",
      "time": "0:19",
      "content": "Great. I'll book that for you. Just a sec.",
      "end_time": 21.45,
      "start_time": 19.16
   },
   {
      "role": "Main Agent",
      "time": "0:22",
      "content": "Okay.",
      "end_time": 23.25,
      "start_time": 22.75
   },
   {
      "data": {
         "id": "call_5otWH44dxeXEHY8RlhYYaFbV",
         "name": "bookUserAppointment",
         "arguments": "{\"name\": \"John\", \"datetime\": \"2024-10-17T18:00:00\"}"
      },
      "role": "Function Call",
      "time": "0:23",
      "content": "",
      "end_time": 23.164,
      "start_time": 23.164
   },
   {
      "data": {
         "id": "call_5otWH44dxeXEHY8RlhYYaFbV",
         "name": "bookUserAppointment",
         "result": "No result returned."
      },
      "role": "Function Call Result",
      "time": "0:24",
      "end_time": 24.6,
      "start_time": 24.6
   },
   {
      "role": "Testing Agent",
      "time": "0:25",
      "content": "1 moment.",
      "end_time": 25.92,
      "start_time": 25.1
   },
   {
      "role": "Main Agent",
      "time": "0:27",
      "content": "Yes. Yes.",
      "end_time": 27.979999999999997,
      "start_time": 27.08
   },
   {
      "role": "Testing Agent",
      "time": "0:27",
      "content": "Appointment booked for 6 PM today.",
      "end_time": 29.5,
      "start_time": 27.08
   },
   {
      "role": "Main Agent",
      "time": "0:30",
      "content": "Oh, okay. Bye.",
      "end_time": 31.72,
      "start_time": 30.64
   },
   {
      "role": "Testing Agent",
      "time": "0:33",
      "content": "Bye.",
      "end_time": 33.6,
      "start_time": 33.1
   }
]

​
Code Examples

curl -X GET https://new-prod.vocera.ai/observability/v1/call-logs-external/:call_log_id/ \
  -H "X-VOCERA-API-KEY: <your-api-key-here>"