List SMS campaigns
GET {{baseUrl}}/phone/sms_campaigns?page_size=30&next_page_token=<string>
Use this API to list all SMS campaigns in a Zoom account.
Prerequisites:
- A Pro or higher account plan
- A Zoom Phone license
Scopes:
phone:read:admin
Granular Scopes:
phone:read:list_sms_campaigns:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| page_size | number | | The number of records returned within a single API call. |
| next_page_token | string | | The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","sms_campaigns":[{"id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","status":"pending","brand":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","status":"--","brand":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"}}],"total_records":"\u003cinteger\u003e"}