Get SMS/MMS charges usage report
GET {{baseUrl}}/phone/reports/sms_charges?from=<date>&to=<date>&page_size=<integer>&next_page_token=<string>&show_charges_only=<boolean>
Retrieves the SMS/MMS Charges Report . The SMS/MMS charges usage report allows account owners and admins to view monthly Zoom phone call charges. Account owners and admins can also access this information by when they log into their Zoom accounts and navigate to SMS/MMS Charges Usage Report . Prerequisites: * Account must be enrolled in Pro or a higher plan * Account must be enrolled in a Zoom Phone plan
Scopes:
phone:read:admin
Granular Scopes:
phone:read:sms_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 | | This field is required only when you specify the from parameter. End time and date is in a yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format. The from parameter uses the the same format. |
| page_size | string | | The number of records returned within a single API call. The default is 30, and the maximum is 300. |
| next_page_token | string | | The current page number of returned records. |
| show_charges_only | string | | This field shows sms/mms with charges only. Defaults to false. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","total_records":"\u003cinteger\u003e","from":"\u003cstring\u003e","to":"\u003cstring\u003e","sms_charges":[{"session_id":"\u003cstring\u003e","message_id":"\u003cstring\u003e","message_type":"\u003cstring\u003e","from_number":"\u003cstring\u003e","from_extension_number":"\u003cstring\u003e","from_display_name":"\u003cstring\u003e","to_number":"\u003cstring\u003e","to_extension_number":"\u003cstring\u003e","to_display_name":"\u003cstring\u003e","sent_time":"\u003cstring\u003e","billing_number":"\u003cstring\u003e","cost_center":"\u003cstring\u003e","department":"\u003cstring\u003e","rate":"\u003cstring\u003e","currency":"\u003cstring\u003e","total_charge":"\u003cstring\u003e"},{"session_id":"\u003cstring\u003e","message_id":"\u003cstring\u003e","message_type":"\u003cstring\u003e","from_number":"\u003cstring\u003e","from_extension_number":"\u003cstring\u003e","from_display_name":"\u003cstring\u003e","to_number":"\u003cstring\u003e","to_extension_number":"\u003cstring\u003e","to_display_name":"\u003cstring\u003e","sent_time":"\u003cstring\u003e","billing_number":"\u003cstring\u003e","cost_center":"\u003cstring\u003e","department":"\u003cstring\u003e","rate":"\u003cstring\u003e","currency":"\u003cstring\u003e","total_charge":"\u003cstring\u003e"}]}