API reference

Carrier phone calls

List and analyze every call across the carrier, and test trunk routing with test_call.

Phone call resource

PhoneCalljson

{
  "data": {
    "id": "CA…",
    "type": "phone_call",
    "attributes": {
      "account_id": "AC…",
      "direction": "inbound",
      "from": "+2348000000001",
      "to": "+2348000000002",
      "status": "completed",
      "duration": "42",
      "price": "-12.50",
      "created_at": "…"
    }
  }
}

List phone calls

GET/carrier/v1/phone_calls

Return calls across the carrier, filterable.

Parameter	Type	Description
`filter[account_id]` optional	`string`	Restrict to an account.
`filter[status]` optional	`string`	Filter by status.
`filter[direction]` optional	`string`	Filter by direction.
`filter[from]` optional	`string`	Filter by origin.
`filter[to]` optional	`string`	Filter by destination.
`page` optional	`integer`	0-indexed page.
`per_page` optional	`integer`	Records per page.

Fetch a call

GET/carrier/v1/phone_calls/{id}

Return a single call.

Update a call

PATCH/carrier/v1/phone_calls/{id}

Update billing data on a call (e.g. to set a manual price).

Parameter	Type	Description
`data.type` required	`string`	`phone_call`
`data.id` required	`string`	The call ID.
`data.attributes.price` optional	`string`	Override the call price.

Carrier call records are the source of truth for billing. Use update to correct prices before reconciliation.