Call Voice

Read the carrier (BYOC) voice calls received on your phone numbers. Each record is the durable form of the call_voice.* webhooks for that call and shares the same id, so you can look a call up by the id a webhook delivered. See SIP Profiles for routing inbound calls to your endpoint.

List carrier (BYOC) voice calls for a phone number

GET/v3/phone-numbers/{phoneNumber}/call-voice

Get a carrier (BYOC) voice call by ID

GET/v3/call-voice/{callVoiceId}

ModelsExpand Collapse

CallVoiceRecord object { id, direction, from, 4 more }

A carrier (BYOC) inbound voice call. Mirrors the call_voice.* webhook payload.

id: string

Stable call id, identical to the id in the call_voice.* webhooks.

formatuuid

direction: "inbound"

from: string

External caller, E.164.

status: "completed" or "busy" or "no_answer" or 2 more

Terminal call outcome. Null while the call is still in progress; set once it ends.

One of the following:

"completed"

"busy"

"no_answer"

"failed"

"canceled"

to: string

Your line that was called, E.164.

ended_at: optional string

When the call ended. Null while still in progress.

formatdate-time

started_at: optional string

When the call was answered. Null if it never connected.

formatdate-time

CallVoiceListResponse object { call_voice, next_cursor }

call_voice: array of CallVoiceRecord { id, direction, from, 4 more }

Calls for the phone number, newest first.

id: string

Stable call id, identical to the id in the call_voice.* webhooks.

formatuuid

direction: "inbound"

from: string

External caller, E.164.

status: "completed" or "busy" or "no_answer" or 2 more

Terminal call outcome. Null while the call is still in progress; set once it ends.

One of the following:

"completed"

"busy"

"no_answer"

"failed"

"canceled"

to: string

Your line that was called, E.164.

ended_at: optional string

When the call ended. Null while still in progress.

formatdate-time

started_at: optional string

When the call was answered. Null if it never connected.

formatdate-time

next_cursor: optional string

Cursor for the next page of results. Null when there are no more. Pass this value as the cursor parameter in the next request.