Skip to navigation

Read call state

Read actual executed publication and independent result readiness. Do not use state text alone to infer result readiness.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

call_idstringRequired1-128 characters
Resource identity within the authenticated workspace.

Response headers

X-Request-IdstringOptional
Safe server request correlation ID.
RateLimit-LimitintegerOptional
Requests allowed in the current window for the tightest applicable limit.
RateLimit-RemainingintegerOptional
Requests left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window resets.

Response

Read call state.
idstring<=128 characters
Opaque call identifier. Do not parse its contents.
agent_idstring<=128 characters
Opaque agent identifier. Do not parse its contents.
published_version_idstring or null<=128 characters
statestring

Canonical call lifecycle value; clients must tolerate new values. Terminality is given separately. Known values: admitted, active, evidence_pending, complete, incomplete, aborted.

terminalboolean
directionstring

Open response vocabulary. Preserve unknown values; never assume they mean success.

created_atdatetime
ended_atdatetime or null
end_reasonstring or null

Safe registered call-end reason.

metadatamap from strings to strings
transcript_statestring

Open response vocabulary. Preserve unknown values; never assume they mean success.

extraction_statestring

Open response vocabulary. Preserve unknown values; never assume they mean success.

from_number_idstring or null<=128 characters

Number used for this call; null for non-phone calls.

updated_atdatetime
poll_after_secondsinteger or null>=1
Seconds before the next useful read. Null when the call is terminal and every result state is settled.
effective_variableslist of objects
summary_statestring

Open response vocabulary. Preserve unknown values; never assume they mean success.

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