Zoom Public API Documentation
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: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_inbound_block_rules:adminMEDIUM
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`: Indicates that only a specific phone number that is shown in the `blocked_number` field is blocked. * `prefix`: Indicates that all numbers starting with the prefix that is shown in the `blocked_number` field are blocked. * `SMS-shortCodes`: Indicates that 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 | |
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": "<string>",
"match_type": "prefix",
"phone_number": "<string>",
"type": "block_as_threat",
"status": "active",
"comment": "<string>",
"blocked_number": "<string>",
"country": "<string>"
},
{
"id": "<string>",
"match_type": "prefix",
"phone_number": "<string>",
"type": "block_for_other_reasons",
"status": "active",
"comment": "<string>",
"blocked_number": "<string>",
"country": "<string>"
}
],
"next_page_token": "<string>",
"page_size": 30
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/inbound_blocked/rules?keyword=<string>&match_type=prefix&type=block_as_threat&status=inactive&next_page_token=<string>&page_size=30?keyword=<string>&match_type=prefix&type=block_as_threat&status=inactive&next_page_token=<string>&page_size=30' -H 'Accept: application/json'
ENDPOINTS