Skip to navigation

List call events

Returns what happened during a call, in order: SMS sent, transfers to a person, knowledge base lookups, actions run by the agent and errors. For calls that passed between agents of a team, segments says which agent handled each part. Events never contain what was said: for that, read the transcript. 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_events"

Always call_events.

call_idstring
Id of the call.
eventslist of objects
What happened during the call, in order of time.
segmentslist of objects
Who handled the call and when, for calls that passed between agents of a team. Empty for calls handled by one agent.

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