Skip to content
Linq Copy agent prompt

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
call_voice.list(strphone_number, CallVoiceListParams**kwargs) -> CallVoiceListResponse
GET/v3/phone-numbers/{phoneNumber}/call-voice
Get a carrier (BYOC) voice call by ID
call_voice.retrieve(strcall_voice_id) -> CallVoiceRecord
GET/v3/call-voice/{callVoiceId}
ModelsExpand Collapse
class CallVoiceRecord: …

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

id: str

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

formatuuid
direction: Literal["inbound"]
from_: str

External caller, E.164.

status: Optional[Literal["completed", "busy", "no_answer", 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: str

Your line that was called, E.164.

ended_at: Optional[datetime]

When the call ended. Null while still in progress.

formatdate-time
started_at: Optional[datetime]

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

formatdate-time
class CallVoiceListResponse: …
call_voice: List[CallVoiceRecord]

Calls for the phone number, newest first.

id: str

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

formatuuid
direction: Literal["inbound"]
from_: str

External caller, E.164.

status: Optional[Literal["completed", "busy", "no_answer", 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: str

Your line that was called, E.164.

ended_at: Optional[datetime]

When the call ended. Null while still in progress.

formatdate-time
started_at: Optional[datetime]

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

formatdate-time
next_cursor: Optional[str]

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