Skip to main content

​
Status and sub-status reference

status is the call’s lifecycle state and sub_status refines it. Every call event carries both, except recording_completed, which has only sub_status.

​
status

​
sub_status

The values depend on status.
  • On registered and retry: QUEUED.
  • On ongoing: ACCEPTED.
On completed, upper-case: On cancelled: On failed and error, sub_status is the telephony provider’s hangup cause, lower-cased, plus a few Ringg reasons. Treat it as a free-form string, not an enum. Common values:

​
Field reference

​
Common fields

Present on every event unless the per-event notes below say otherwise.
​
string
required
One of call_started, call_ringing, call_ongoing, call_completed, chat_completed, recording_completed, platform_analysis_completed, client_analysis_completed, all_processing_completed.
​
string
Unique ID of this event. On call_started; call_ringing and call_ongoing don’t carry it.
​
string
ISO 8601 time the event was generated, UTC.
​
string
Event schema version, for example "1.0".
​
string
required
The call’s ID.
​
string | null
required
The call this one was created from; null if dialled directly. See Linking retries and callbacks.
​
string | null
The telephony provider’s call ID. null until the call is dialled.
​
string
The agent that handled the call. Not on recording_completed.
​
string
Your workspace ID. Not on recording_completed.
​
string
Telephony provider of the number that placed the call, for example plivo, twilio, exotel, vobiz. Only on call_started for API, campaign and scheduled calls; not on test calls, web calls or any other event. Can be null.
​
object
The variables you sent when starting the call.
​
string | null
The campaign list the call belongs to; null for single calls.
​
string
The agent’s display name.
​
string
The agent version used.
​
string
Slug of the agent version, for example v1. Not on recording_completed.
​
string | null
Description of the agent version. Not on recording_completed.
​
number | null
Cost of the call in credits; null until calculated.
​
number | null
Total response latency in seconds (sum of the median latencies across metrics).
​
number | null
Time to the agent’s first spoken response, in seconds.
​
array
Logs of the tools run before and during the call.

​
Call started fields

​
string
Normally registered; ongoing on the second call_started a fast-connecting call can send.
​
string
Normally QUEUED; ACCEPTED on the ongoing variant.
​
string
outbound or webcall; inbound phone calls don’t send call_started.
​
string
The number being called.
​
string
The caller ID.

​
Call completed fields

Also present on platform_analysis_completed, client_analysis_completed and all_processing_completed.
​
string
completed, failed, error, cancelled, forwarded, or the interim retry. See Status and sub-status reference.
​
string
The reason, for example ACCEPTED, busy line, not_able_to_call.
​
string
inbound, outbound or webcall.
​
number | null
Seconds; null if the call never connected.
​
string
The number that received the call.
​
string
The number that placed the call.
​
string
ISO 8601 time this attempt was dialled, UTC.
​
string
ISO 8601 time the call record was created, UTC.
​
array
Turns as { "bot": "…" } and { "user": "…" } entries. Empty if the call never connected.
​
number
Messages spoken by the agent.
​
number
Messages spoken by the user.
​
number
Retries so far; 0 on the first attempt. call_completed only.
​
array
Dial history, oldest first. call_completed only.
​
string | null
null on call_completed; the recording arrives with recording_completed and all_processing_completed.

​
Recording fields

recording_completed carries the common fields except status, agent_id, workspace_id, version_slug and version_description, plus:
​
string
Recording URL. It may expire about a day after the event is sent; Get Call Details always returns a fresh link.
​
number
Recording length in seconds.
​
string
The call’s sub-status.

​
Analysis fields

​
string
call for calls, chat for WhatsApp chats.
​
object
The results. On client_analysis_completed the keys are the ones you defined in Advanced Analysis. On platform_analysis_completed:

​
All processing completed fields

Every common field, the call completed fields, plus:
​
string
Same as recording_completed’s recording_url.
​
object
Same shape as platform_analysis_completed’s analysis_data.
​
string
success, failed, not_enabled or cancelled.
​
object
Same shape as client_analysis_completed’s analysis_data: the keys you defined.
​
string
success, failed, not_enabled or cancelled.