Zoom Public API Documentation
List an extension's inbound block rules
GET {{baseUrl}}/phone/extension/:extensionId/inbound_blocked/rules?keyword=<string>&match_type=prefix&type=block_as_threat&next_page_token=<string>&page_size=30
Returns a list of the given extension's block rule for inbound calls and messaging. it lists inbound block rule for the given Call Queue, Auto Receptionist, Shared Line Group, Common Area, Zoom Room, or User. Prerequisites:
* Pro or a higher account with Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:admin,phone:readphone:read:list_extension_inbound_block_rules:admin,phone:read:list_extension_inbound_block_rulesMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
keyword
|
string | The partial string of a phone number. | |
match_type
|
string | The match type for the block rule: * `phoneNumber`: Only a specific phone number that is shown in the `blocked_number` field is blocked. * `prefix`: All numbers starting with the prefix that is shown in the `blocked_number` field are blocked. * `SMS-shortCodes`: Only a specific SMS short code that is shown in the `blocked_number` field is blocked. | |
type
|
string | The block type for the block rule: * `block_for_other_reasons` * `block_as_threat` | |
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
| {
"extension_blocked_rules": [
{
"id": "<string>",
"match_type": "prefix",
"phone_number": "<string>",
"type": "block_for_other_reasons",
"blocked_number": "<string>",
"country": "<string>"
},
{
"id": "<string>",
"match_type": "SMS-shortCodes",
"phone_number": "<string>",
"type": "block_for_other_reasons",
"blocked_number": "<string>",
"country": "<string>"
}
],
"next_page_token": "<string>",
"page_size": 30
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/extension/:extensionId/inbound_blocked/rules?keyword=<string>&match_type=prefix&type=block_as_threat&next_page_token=<string>&page_size=30?keyword=<string>&match_type=prefix&type=block_as_threat&next_page_token=<string>&page_size=30' -H 'Accept: application/json'
ENDPOINTS