Get Call Report for extension
Returns data about usage of phone service for extension
Request
- Base URL: https://api.phone.com
- URL: https://api.phone.com/v4/accounts/{voip_id}/extensions/{extension_id}/call-reports
- Auth: HTTP bearer
Path parameters
Query parameters
The number of items to skip before starting to collect the result set
The number of items to return
Sort response
Send "1" if you want to add subaccounts data into output
Grouping parameter
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"
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)
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".
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)
Call direction (in seconds)
Extension ID
Called number
Call duration
Phone number (called number for inbound, caller id for outbound)
Defines mode of the data output (brief or full)
Response
OK
Changes
No operation changes recorded.