List blocked lists
GET {{baseUrl}}/phone/blocked_list?next_page_token=<string>&page_size=30
A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to list all the blocked lists in an acccount. Prerequisites:
* Pro or higher account plan with Zoom phone license Scopes: Granular Scopes: Rate Limit Label: phone:read:adminphone:read:list_blocked_lists:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
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. | |
page_size
|
number | The total number of records returned from a single API call. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"blocked_list": [
{
"block_type": "inbound",
"comment": "<string>",
"id": "<string>",
"match_type": "prefix",
"phone_number": "<string>",
"status": "inactive"
},
{
"block_type": "outbound",
"comment": "<string>",
"id": "<string>",
"match_type": "phoneNumber",
"phone_number": "<string>",
"status": "active"
}
],
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>"
} |
ENDPOINTS