# Call Voice

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

`client.CallVoice.List(ctx, phoneNumber, query) (*CallVoiceListResponse, error)`

**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

- `phoneNumber string`

- `query CallVoiceListParams`

  - `Cursor param.Field[string]`

    Pagination cursor from a previous next_cursor response

  - `Limit param.Field[int64]`

    Maximum number of calls to return

### Returns

- `type CallVoiceListResponse struct{…}`

  - `CallVoice []CallVoiceRecord`

    Calls for the phone number, newest first.

    - `ID string`

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

    - `Direction CallVoiceRecordDirection`

      - `const CallVoiceRecordDirectionInbound CallVoiceRecordDirection = "inbound"`

    - `From string`

      External caller, E.164.

    - `Status CallVoiceRecordStatus`

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

      - `const CallVoiceRecordStatusCompleted CallVoiceRecordStatus = "completed"`

      - `const CallVoiceRecordStatusBusy CallVoiceRecordStatus = "busy"`

      - `const CallVoiceRecordStatusNoAnswer CallVoiceRecordStatus = "no_answer"`

      - `const CallVoiceRecordStatusFailed CallVoiceRecordStatus = "failed"`

      - `const CallVoiceRecordStatusCanceled CallVoiceRecordStatus = "canceled"`

    - `To string`

      Your line that was called, E.164.

    - `EndedAt Time`

      When the call ended. Null while still in progress.

    - `StartedAt Time`

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

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

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/linq-team/linq-go"
  "github.com/linq-team/linq-go/option"
)

func main() {
  client := linqgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  callVoices, err := client.CallVoice.List(
    context.TODO(),
    "+14254758217",
    linqgo.CallVoiceListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", callVoices.CallVoice)
}
```

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

`client.CallVoice.Get(ctx, callVoiceID) (*CallVoiceRecord, error)`

**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

- `callVoiceID string`

### Returns

- `type CallVoiceRecord struct{…}`

  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.

  - `Direction CallVoiceRecordDirection`

    - `const CallVoiceRecordDirectionInbound CallVoiceRecordDirection = "inbound"`

  - `From string`

    External caller, E.164.

  - `Status CallVoiceRecordStatus`

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

    - `const CallVoiceRecordStatusCompleted CallVoiceRecordStatus = "completed"`

    - `const CallVoiceRecordStatusBusy CallVoiceRecordStatus = "busy"`

    - `const CallVoiceRecordStatusNoAnswer CallVoiceRecordStatus = "no_answer"`

    - `const CallVoiceRecordStatusFailed CallVoiceRecordStatus = "failed"`

    - `const CallVoiceRecordStatusCanceled CallVoiceRecordStatus = "canceled"`

  - `To string`

    Your line that was called, E.164.

  - `EndedAt Time`

    When the call ended. Null while still in progress.

  - `StartedAt Time`

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

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/linq-team/linq-go"
  "github.com/linq-team/linq-go/option"
)

func main() {
  client := linqgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  callVoiceRecord, err := client.CallVoice.Get(context.TODO(), "550e8400-e29b-41d4-a716-446655440000")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", callVoiceRecord.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

- `type CallVoiceRecord struct{…}`

  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.

  - `Direction CallVoiceRecordDirection`

    - `const CallVoiceRecordDirectionInbound CallVoiceRecordDirection = "inbound"`

  - `From string`

    External caller, E.164.

  - `Status CallVoiceRecordStatus`

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

    - `const CallVoiceRecordStatusCompleted CallVoiceRecordStatus = "completed"`

    - `const CallVoiceRecordStatusBusy CallVoiceRecordStatus = "busy"`

    - `const CallVoiceRecordStatusNoAnswer CallVoiceRecordStatus = "no_answer"`

    - `const CallVoiceRecordStatusFailed CallVoiceRecordStatus = "failed"`

    - `const CallVoiceRecordStatusCanceled CallVoiceRecordStatus = "canceled"`

  - `To string`

    Your line that was called, E.164.

  - `EndedAt Time`

    When the call ended. Null while still in progress.

  - `StartedAt Time`

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