Call Reports

Get Call Report

Returns data about usage of phone service

get/v4/accounts/{voip_id}/call-reports

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/call-reports
  • Auth: HTTP bearer

Path parameters

voip_idinteger required

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

sort[id]'asc' | 'desc'

Sort response

include_subaccountsinteger

Send "1" if you want to add subaccounts data into output

group_by'date' | 'hour' | 'minute' | 'week' | 'duration' | 'npa' | 'direction' | 'number' | 'extension'

Grouping parameter

fieldsstring

List of fields for report (comma-separated). Available values: "min_call_duration", "avg_call_duration", "max_call_duration", "total_call_duration", "min_amount", "avg_amount", "max_amount", "total_amount", "first_time", "last_time", "count_incoming", "count_outgoing", "total"

tz_offsetstring

By default grouping by date (week), will be based on GMT. You can adjust it by providing timezone offset in seconds (like "-18000" for New York)

filters[start_time]string

Call start time. Expected value is UNIX timestamp with operator like "gt" (greater than), "gte" (greater than or equals), "lt" (lesser than), "lte" (lesser than or equals). Example: "gt:1597778180".

filters[created_at]string

Call log creation time. This filter is required and can be defined like this: filters[created_at]=between:1613999999,1614100000 (values are UNIX timestamps; not included into selection)

filters[direction]string

Call direction (in seconds)

filters[extension]string

Extension ID

filters[called_number]string

Called number

filters[call_duration]string

Call duration

filters[number]string

Phone number (called number for inbound, caller id for outbound)

mode'brief' | 'full'

Defines mode of the data output (brief or full)

Response

OK

filtersobject
sortobject
totalinteger
limitinteger
offsetinteger
itemsobject[]

Changes

No operation changes recorded.