Skip to navigation

Get call transcript

Returns the conversation of a call turn by turn, with who spoke and when. The transcript is the most sensitive data of a call: every read of an available transcript is recorded in the audit log of the organization, with the key that made it. status is processing while the call is still in progress and unavailable when there is nothing to read (for example a call missed before the agent answered). Required scope: calls:read. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

call_idstringRequiredformat: "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,127}$"

Id of the call, as returned by GET /calls or by a webhook event.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Response

Successful response.
object"call_transcript"

Always call_transcript.

call_idstring
Id of the call.
statusenum

available: turns holds the conversation. processing: the call is still in progress. unavailable: there is nothing to read; turns is empty.

Allowed values:
turnslist of objects
The conversation, turn by turn, in order.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error