API Reference

Get Call Report

get
https://api.phone.com/v4/accounts//call-reports

Returns data about usage of phone service

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1
Query Params
integer
≥ 0
Defaults to 0

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

integer
1 to 500
Defaults to 25

The number of items to return

string
enum

Sort response

Allowed:
integer
≥ 0
Defaults to 0

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

string
enum
Defaults to date

Grouping parameter

string
Defaults to count_incoming,count_outgoing,total

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"

string
Defaults to 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)

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".

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)

string

Call direction (in seconds)

string

Extension ID

string

Called number

string

Call duration

string

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

string
enum
Defaults to full

Defines mode of the data output (brief or full)

Allowed:
Responses

Updated 6 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago