Skip to content
Linq Copy agent prompt

Get a carrier (BYOC) voice call by ID

call_voice.retrieve(strcall_voice_id) -> CallVoiceRecord
GET/v3/call-voice/{callVoiceId}

Retrieve a single carrier voice call by its id — the same id delivered in the call_voice.* webhooks and returned by the list endpoint. The call must belong to the authenticated partner.

ParametersExpand Collapse
call_voice_id: str
formatuuid
ReturnsExpand 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

Get a carrier (BYOC) voice call by ID

import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
call_voice_record = client.call_voice.retrieve(
    "550e8400-e29b-41d4-a716-446655440000",
)
print(call_voice_record.id)
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "direction": "inbound",
  "from": "+12052532136",
  "status": "completed",
  "to": "+12052535597",
  "ended_at": "2026-03-05T12:05:00Z",
  "started_at": "2026-03-05T12:00:05Z"
}
{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2004/"
  },
  "success": false
}
{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2001/"
  },
  "success": false
}
{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/3xxx/3006/"
  },
  "success": false
}
Returns Examples
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "direction": "inbound",
  "from": "+12052532136",
  "status": "completed",
  "to": "+12052535597",
  "ended_at": "2026-03-05T12:05:00Z",
  "started_at": "2026-03-05T12:00:05Z"
}
{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2004/"
  },
  "success": false
}
{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2001/"
  },
  "success": false
}
{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/3xxx/3006/"
  },
  "success": false
}