Stream status

GET

/v1/calls/{callId}/stream

const url = 'https://your-machine.your-tailnet.ts.net/v1/calls/example/stream';
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/stream \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer
apiKey

Parameters

Path Parameters

callId

required

string

Responses

200

Stream status.

application/json

object

stream

One of:

object
null

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

status

string

Allowed values: off waiting connecting live ended error

error

string

Example

{
  "stream": {
    "url": "wss://agent.example.com/ws",
    "format": "raw"
  },
  "status": "off"
}

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