Skip to content

SIP / Calls API

Open API playground All endpoints

Read calls that arrived or left over your SIP trunks (st_).

List SIP calls

GET/api/v1/sip/calls

List calls that traversed your SIP trunks, newest first. Filter by trunk, numbers, or creation time, and page with cursors (see the Pagination section in the overview).

Auth: x-api-key header

Parameters

NameInTypeDescription
trunk_idquerystring | null

Filter by SIP trunk. Accepts the st_<ULID> identifier.

from_numberquerystring | null
to_numberquerystring | null
created_afterquerystring (date-time) | null
created_beforequerystring (date-time) | null
limitqueryinteger
cursor_afterquerystring | null
cursor_beforequerystring | null

Responses

StatusDescription
200

Successful Response

400

The pagination cursor is invalid or has expired.

403

The x-api-key header is missing or invalid.

422

The request body or query parameters failed validation.

Example response (200)
{
  "data": [
    {
      "account_id": "acc_01JQ8Z9K7M3N2P4R5S6T7V8WIJ",
      "answered_at": "2026-06-01T09:15:12Z",
      "created_at": "2026-06-01T09:15:04Z",
      "direction": "inbound",
      "duration_seconds": 156,
      "ended_at": "2026-06-01T09:17:48Z",
      "ended_by": "caller",
      "from_number": "+14155552671",
      "id": "cs_01JQ8Z9K7M3N2P4R5S6T7V8W9X",
      "reason": "completed",
      "recordings": [
        "rec_01JQ8Z9K7M3N2P4R5S6T7V8WEF"
      ],
      "sip_trunk_id": "st_01JQ8Z9K7M3N2P4R5S6T7V8WMN",
      "state": "completed",
      "to_number": "+14155559876"
    }
  ],
  "next_cursor": "string",
  "previous_cursor": "string",
  "has_more": false
}

Retrieve a SIP call

GET/api/v1/sip/calls/{call_id}

Retrieve a single SIP call by its identifier.

Auth: x-api-key header

Parameters

NameInTypeDescription
call_id requiredpathstring

Responses

StatusDescription
200

Successful Response

403

The x-api-key header is missing or invalid.

404

No call matches the supplied identifier for this account.

422

Validation Error

Example response (200)
{
  "account_id": "acc_01JQ8Z9K7M3N2P4R5S6T7V8WIJ",
  "answered_at": "2026-06-01T09:15:12Z",
  "created_at": "2026-06-01T09:15:04Z",
  "direction": "inbound",
  "duration_seconds": 156,
  "ended_at": "2026-06-01T09:17:48Z",
  "ended_by": "caller",
  "from_number": "+14155552671",
  "id": "cs_01JQ8Z9K7M3N2P4R5S6T7V8W9X",
  "reason": "completed",
  "recordings": [
    "rec_01JQ8Z9K7M3N2P4R5S6T7V8WEF"
  ],
  "sip_trunk_id": "st_01JQ8Z9K7M3N2P4R5S6T7V8WMN",
  "state": "completed",
  "to_number": "+14155559876"
}