VocalDocscontracts 1.65.0

Read the trace of a finalized Call as OTLP JSON

GET /v1/calls/{call_id}/trace/otlp

PropertyValue
Operationget_call_trace_otlp
GroupCall trace and analytics
Scopecalls:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A metadata read; the OTLP form carries no content class.
Released in1.57.0
Phase 0 hostServed (the hosted api pins 1.65.0)

The same trace as GET /v1/calls/{call_id}/trace in the OTLP JSON encoding (1.57.0), an ExportTraceServiceRequest the customer's own collector accepts: a root span call.session, one span per segment and one span event per mark. Metadata and stage traces only, never a content class; turns limits the segments as on the trace read. The trace id is the one of the traceparent POST /v1/calls carried, else one derived from the Call id.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the calls:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/calls/call_.../trace/otlp" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
call_idpathCallIdyesThe id of a Call: call_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
turnsquerystringnoOnly the turn segments whose Turn seq is in this range, both ends inclusive, as 3-7 or 4 (1.57.0); the setup and end segments, the envelopes and the content classes are limited to the same Turns. Absent: the whole trace.

Responses

StatusContent typeShapeError codes
200application/jsonOtlpTraceExport
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is OtlpTraceExport.

FieldTypeRequiredDescription
resourceSpansarray of OtlpResourceSpansyes