Calls

Calls by destination report

Returns outbound call totals per destination network for a date range, as the Calls by Destination report in the portal: number of calls, successful (billable) calls, total duration in seconds, total cost, ASR (percent) and ACD (seconds), plus totals for the whole range. Data is aggregated per calendar day (UTC); without time_range the last week is returned and a range can span at most 1 year. Results can be narrowed by SIP account, country (ISO 3166-1 alpha-2 code) and network type, and split per SIP account with group_by_sip_account.

get/call_records/destinations

Request

Base URL
https://api.commpeak.com/portal
URL
https://api.commpeak.com/portal/call_records/destinations
Auth
API key in header Authorization

Query parameters

time_rangestring nullable

Date range "YYYY-MM-DD - YYYY-MM-DD" (or a single date).

sip_account_idstring nullable

Filter by SIP account display_token.

countrystring nullable

Filter by destination country, ISO 3166-1 alpha-2 code (e.g. US).

network_typestring nullable

Filter by network type: fixed, mobile, other, premium, sharedcost.

group_by_sip_accountboolean nullable

Split the rows per SIP account.

Response

Successful Response

Example response

{
  "destinations": [
    {
      "acd": 142.5,
      "asr": 80,
      "cost": 1.539,
      "country": "US",
      "network": "United States - Fixed - New York",
      "network_type": "fixed",
      "successful_calls": 96,
      "total_calls": 120,
      "total_time": 13680
    }
  ],
  "totals": {
    "acd": 142.5,
    "asr": 80,
    "cost": 1.539,
    "successful_calls": 96,
    "total_calls": 120,
    "total_time": 13680
  }
}

Changes

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