API ReferenceCalls

Get call

Single call log with started_at, ringing_at, answered_at, ended_at, and conversation_logs (voice transcript messages).

GET
/api/v1/console/agents/{agentId}/calls/{callId}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Path Parameters

agentId*string
callId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/console/agents/string/calls/string"
{  "message": "Success",  "data": {    "id": "string",    "source": "+14155550100",    "destination": "+2348012345678",    "status": "queued",    "direction": "outbound",    "created_on": "2019-08-24T14:15:22Z",    "duration_seconds": 42,    "is_test_call": true,    "error_reason": "string",    "end_reason": "string",    "ringing_at": "2019-08-24T14:15:22Z",    "ended_at": "2019-08-24T14:15:22Z",    "started_at": "2019-08-24T14:15:22Z",    "answered_at": "2019-08-24T14:15:22Z",    "conversation_logs": [      {        "id": "string",        "role": "string",        "message": "string",        "message_type": "string",        "created_at": "2019-08-24T14:15:22Z",        "attachments": [          {            "type": "image",            "url": "http://example.com"          }        ]      }    ]  }}
{  "message": "Invalid API key.",  "error": "Unauthorized",  "code": "api_key_invalid",  "statusCode": 401,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
{  "message": "This API key is missing the required scope: conversations:read.",  "error": "Forbidden",  "code": "insufficient_scope",  "statusCode": 403,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
{  "message": "Call not found",  "error": "Not Found",  "code": "not_found",  "statusCode": 404,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}

Stream messages (SSE)

Server-Sent Events stream of new messages for a conversation. Authenticate with a ?ticket= obtained from POST .../stream-ticket. Supports reconnect via Last-Event-ID header or ?after=<chatId|ISO>. Emits "message" and periodic "heartbeat" events.

List calls

Paginated telephony call logs for an agent. Returns id, source, destination, status, direction, created_on, duration_seconds, is_test_call, error_reason, end_reason, ringing_at, and ended_at.