# Call Voice

## List carrier (BYOC) voice calls for a phone number

`call_voice.list(strphone_number, CallVoiceListParams**kwargs)  -> CallVoiceListResponse`

**get** `/v3/phone-numbers/{phoneNumber}/call-voice`

List the carrier voice calls received on one of your phone numbers,
newest first, with cursor pagination. Each record is the durable form of
the `call_voice.*` webhooks for that call; the `id` is the same id those
webhooks carry. Results are scoped to the authenticated partner — a number
that isn't yours (or simply has no calls) returns `200` with an empty
`call_voice` array, not an error.

### Parameters

- `phone_number: str`

- `cursor: Optional[str]`

  Pagination cursor from a previous next_cursor response

- `limit: Optional[int]`

  Maximum number of calls to return

### Returns

- `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.

    - `direction: Literal["inbound"]`

      - `"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.

      - `"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.

    - `started_at: Optional[datetime]`

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

  - `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.

### Example

```python
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_voices = client.call_voice.list(
    phone_number="+14254758217",
)
print(call_voices.call_voice)
```

#### Response

```json
{
  "call_voice": [
    {
      "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"
    }
  ],
  "next_cursor": "next_cursor"
}
```

## 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.

### Parameters

- `call_voice_id: str`

### Returns

- `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.

  - `direction: Literal["inbound"]`

    - `"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.

    - `"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.

  - `started_at: Optional[datetime]`

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

### Example

```python
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)
```

#### Response

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

## Domain Types

### Call Voice Record

- `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.

  - `direction: Literal["inbound"]`

    - `"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.

    - `"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.

  - `started_at: Optional[datetime]`

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

### Call Voice List Response

- `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.

    - `direction: Literal["inbound"]`

      - `"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.

      - `"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.

    - `started_at: Optional[datetime]`

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

  - `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.
