Get a carrier (BYOC) voice call by ID

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.

Path ParametersExpand Collapse

callVoiceId: string

formatuuid

ReturnsExpand 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

Get a carrier (BYOC) voice call by ID

curl https://api.linqapp.com/api/partner/v3/call-voice/$CALL_VOICE_ID \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY"

{
  "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
}