Get a call

GET

/v1/calls/{callId}

const url = 'https://your-machine.your-tailnet.ts.net/v1/calls/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://your-machine.your-tailnet.ts.net/v1/calls/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer
apiKey

Parameters

Path Parameters

callId

required

string

Responses

200

The call and where to join its audio.

application/json

object

call

required

object

required

string

deviceId

required

string

remoteNumber

required

string

direction

required

string

Allowed values: outgoing incoming

state

required

string

Allowed values: queued dialing ringing active held ended rejected failed

nativeCallId

string

webhookUrl

string format: uri

metadata

object

key

additional properties

any

stream

Your agent’s WebSocket. The gateway connects to it when the call is answered.

object

url

required

ws:// or wss://.

string

format

raw: 16 kHz s16le binary frames. twilio: Twilio Media Streams JSON with 8 kHz mu-law, compatible with Twilio integrations such as Pipecat’s.

string

default: raw

Allowed values: raw twilio

parameters

Sent to your agent in the start message (Twilio customParameters).

object

key

additional properties

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

answeredAt

string format: date-time

endedAt

string format: date-time

media

required

Where to join this call’s audio yourself (WebSocket).

object

path

string

format

object

encoding

string

Allowed value: pcm_s16le

sampleRate

integer

Allowed value: 16000

channels

integer

Allowed value: 1

frameMs

integer

Allowed value: 20

streaming

The phone is sending audio right now.

boolean

Example

{
  "call": {
    "remoteNumber": "+919876543210",
    "direction": "outgoing",
    "state": "queued",
    "stream": {
      "url": "wss://agent.example.com/ws",
      "format": "raw"
    }
  },
  "media": {
    "path": "/v1/calls/9b2e/media",
    "format": {
      "encoding": "pcm_s16le",
      "sampleRate": 16000,
      "channels": 1,
      "frameMs": 20
    }
  }
}

401

Missing or invalid API key.

application/json

object

error

required

object

code

required

string

message

required

string

issues

Validation details

Array

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "invalid API key or session"
  }
}

404

Not found.

application/json

object

error

required

object

code

required

string

message

required

string

issues

Validation details

Array

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "call not found"
  }
}