Logo
Zoom Public API Documentation

List user level outbound calling exception rules

GET {{baseUrl}}/phone/users/:userId/outbound_calling/exception_rules?country=<string>&keyword=<string>&match_type=prefix&status=inactive&next_page_token=<string>&page_size=30

Lists the user level outbound calling policy exception rules.

Prerequisite: * Pro or higher account plan with Zoom phone license

Scopes: phone:read:admin

Granular Scopes: phone:read:user_outbound_calling_rule:admin

Rate Limit Label: MEDIUM

 

Body PARAM

Key Datatype Required Description 
country
string The [country ISO code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).
keyword
string The partial string of a phone number.
match_type
string The match type of an exception rule.
status
string The status of an exception rule.
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.
page_size
number The number of records in a single API call.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "exception_rules": [ { "id": "<string>", "match_type": "prefix", "prefix_number": "<string>", "rule": 4, "comment": "<string>", "status": "inactive" }, { "id": "<string>", "match_type": "prefix", "prefix_number": "<string>", "rule": 2, "comment": "<string>", "status": "active" } ], "next_page_token": "<string>", "page_size": 30 }



Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/outbound_calling/exception_rules?country=<string>&keyword=<string>&match_type=prefix&status=inactive&next_page_token=<string>&page_size=30?country=<string>&keyword=<string>&match_type=prefix&status=inactive&next_page_token=<string>&page_size=30' -H 'Accept: application/json'

ENDPOINTS