Skip to content
Linq Copy agent prompt

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.

ParametersExpand Collapse
callVoiceID string
formatuuid
ReturnsExpand Collapse
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.

formatuuid
Direction CallVoiceRecordDirection
From string

External caller, E.164.

Status CallVoiceRecordStatus

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

One of the following:
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 TimeOptional

When the call ended. Null while still in progress.

formatdate-time
StartedAt TimeOptional

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

formatdate-time

Get a carrier (BYOC) voice call by ID

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