Get call charges usage report
GET {{baseUrl}}/phone/reports/call_charges?from=<date>&to=<date>&page_size=<integer>&next_page_token=<string>&billing_account_id=<string>&show_charges_only=<boolean>
Retrieves the Phone Call Charges Report .
The Call charges usage report allows account owners and admins to view monthly Zoom phone call charges. Account owners and admins can also access this information when they log into their Zoom accounts and navigate to Call Charges Usage Report .
Prerequisites:
- Account must be enrollled in Pro or a higher plan
- Account must be enrolled in a Zoom Phone plan
Scopes:
phone:read:admin
Granular Scopes:
phone:read:call_charges:admin
Rate Limit Label
:
HEAVY
Request Params
| Key | Datatype | Required | Description |
| from | string | | The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format. The date range defined by the from and to parameters should be a month as the response only includes one month's worth of data at once. The from date should not exceed recent 13 months. If unspecified, it returns data from the past 30 days. |
| to | string | | Required only when the from parameter is specified. The end time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format is the same format as the from parameter. |
| page_size | string | | The number of records to be returned within a single API call. The default is 30 and the maximum is 300. |
| next_page_token | string | | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.. |
| billing_account_id | string | | The billing account ID. |
| show_charges_only | string | | This field shows calls with charges only. The default value is false. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","from":"\u003cstring\u003e","to":"\u003cstring\u003e","call_charges":[{"call_log_id":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","caller_billing_number":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","callee_billing_number":"\u003cstring\u003e","call_type":"international","service_type":"meeting","calling_party_name":"\u003cstring\u003e","cost_center":"\u003cstring\u003e","employee_id":"\u003cstring\u003e","department":"\u003cstring\u003e","end_time":"\u003cstring\u003e","duration":"\u003cinteger\u003e","charge_mode":"per_min_after_t_duration","rate":"\u003cstring\u003e","currency":"\u003cstring\u003e","total_charge":"\u003cstring\u003e","billing_number":"\u003cstring\u003e","forward_number_billing":"\u003cstring\u003e"},{"call_log_id":"\u003cstring\u003e","caller_number":"\u003cstring\u003e","caller_billing_number":"\u003cstring\u003e","callee_number":"\u003cstring\u003e","callee_billing_number":"\u003cstring\u003e","call_type":"callCenter","service_type":"call","calling_party_name":"\u003cstring\u003e","cost_center":"\u003cstring\u003e","employee_id":"\u003cstring\u003e","department":"\u003cstring\u003e","end_time":"\u003cstring\u003e","duration":"\u003cinteger\u003e","charge_mode":"per_min_after_t_duration","rate":"\u003cstring\u003e","currency":"\u003cstring\u003e","total_charge":"\u003cstring\u003e","billing_number":"\u003cstring\u003e","forward_number_billing":"\u003cstring\u003e"}]}