Calls

Get specific call

Retrieve a single call by its numeric id.

When to use. Drill-down to the full detail of one call, for example from a list row. Returns 404 if the id does not exist or is not visible to your API user.

Shape. { "calls": [ <call> ] }, a single-element array that matches the list endpoint's envelope.

Gateway note: custom call fields defined on the account can be used as filter keys (path segments, see the _filtered variant) and are returned on each record alongside the standard fields.

get/{sub_domain}/api/calls/{id}

Request

Base URL
https://api.commpeak.com/pbx
URL
https://api.commpeak.com/pbx/{sub_domain}/api/calls/{id}
Auth
API key in header Authorization

Path parameters

idinteger required

Call ID.

sub_domainstring required

PBX Name (subdomain)

Response

Successful Response

total_callsinteger nullable

Total number of matching calls.

Example response

{
  "calls": [
    {
      "agent_callerid_name": "demo",
      "agent_callerid_number": "12125551234",
      "call_bill_duration": 22,
      "call_duration": 23,
      "call_uuid": "c5b52188-9e16-4ee3-b030-3ad545b1636d",
      "caller_user": "demo",
      "caller_user_id": 970,
      "client_callerid_name": "demo",
      "client_callerid_number": "12125551234",
      "cost": 0,
      "created_at": "2025-05-18 12:45:27",
      "dst": "12125551234",
      "end_at": "2025-05-18 12:45:48",
      "id": 40227,
      "object_id": 0,
      "object_type_id": 3,
      "q850": 16,
      "sip_term_status": 200,
      "src": "demo@demo.example.com",
      "start_at": "2025-05-18 12:45:27",
      "status": "NORMAL_CLEARING"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.