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: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:sms_charges:adminHEAVY
Body
PARAM
| 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": "<string>",
"page_size": "<integer>",
"total_records": "<integer>",
"from": "<string>",
"to": "<string>",
"sms_charges": [
{
"session_id": "<string>",
"message_id": "<string>",
"message_type": "<string>",
"from_number": "<string>",
"from_extension_number": "<string>",
"from_display_name": "<string>",
"to_number": "<string>",
"to_extension_number": "<string>",
"to_display_name": "<string>",
"sent_time": "<string>",
"billing_number": "<string>",
"cost_center": "<string>",
"department": "<string>",
"rate": "<string>",
"currency": "<string>",
"total_charge": "<string>"
},
{
"session_id": "<string>",
"message_id": "<string>",
"message_type": "<string>",
"from_number": "<string>",
"from_extension_number": "<string>",
"from_display_name": "<string>",
"to_number": "<string>",
"to_extension_number": "<string>",
"to_display_name": "<string>",
"sent_time": "<string>",
"billing_number": "<string>",
"cost_center": "<string>",
"department": "<string>",
"rate": "<string>",
"currency": "<string>",
"total_charge": "<string>"
}
]
} |
ENDPOINTS