List an account's inbound block rules
GET {{baseUrl}}/phone/inbound_blocked/rules?keyword=<string>&match_type=prefix&type=block_as_threat&status=inactive&next_page_token=<string>&page_size=30
Returns a list of account level inbound block rule for inbound calls and messaging.
Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
Scopes:
phone:read:admin
Granular Scopes:
phone:read:list_inbound_block_rules:admin
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| keyword | string | | The partial string of a phone number. |
| match_type | string | | The match type for the block rule:
phoneNumber: Indicates that only a specific phone number that is shown in theblocked_numberfield is blocked.prefix: Indicates that all numbers starting with the prefix that is shown in theblocked_numberfield are blocked.SMS-shortCodes: Indicates that only a specific SMS short code that is shown in theblocked_numberfield is blocked. | |type| string | | The block type for the block rule:- block_for_other_reasons
- block_as_threat |
|
status| string | | Whether the block rule is active or inactive. active: The block rule is active.inactive: The block rule is inactive. | |next_page_token| string | | The next page token paginates through a large set of results. It 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
{"account_blocked_rules":[{"id":"\u003cstring\u003e","match_type":"prefix","phone_number":"\u003cstring\u003e","type":"block_as_threat","status":"active","comment":"\u003cstring\u003e","blocked_number":"\u003cstring\u003e","country":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","match_type":"prefix","phone_number":"\u003cstring\u003e","type":"block_for_other_reasons","status":"active","comment":"\u003cstring\u003e","blocked_number":"\u003cstring\u003e","country":"\u003cstring\u003e"}],"next_page_token":"\u003cstring\u003e","page_size":30}