List blocked lists

GET

/phone/blocked_list

Phone Blocked List

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
Scope: phone:read:admin

Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/phone/blocked_list'

响应示例

{
    "blocked_list": [
        {
            "block_type": "inbound",
            "comment": "Blocked numbers starting with 777",
            "id": "7buyurtKc0Zw",
            "match_type": "prefix",
            "phone_number": "1777",
            "status": "active"
        },
        {
            "block_type": "inbound",
            "comment": "Blocked an unknown caller",
            "id": "cYDtrtyrgyQw",
            "match_type": "phoneNumber",
            "phone_number": "600040404",
            "status": "active"
        }
    ],
    "next_page_token": "",
    "page_size": 30,
    "total_records": 2
}

请求参数

Query 参数

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

page_size

integer

可选

The total number of records returned from a single API call.

<= 100

默认值:

返回响应

🟢200**HTTP Status Code:** `200` **OK**<br> Blocked list returned successfully.

application/json

Body

blocked_list

array [object {6}]

可选

block_type

enum<string>

可选

Block type.
inbound: The blocked number or numbers with the specifie prefix are prevented from calling in to phone users.

outbound: The phone users are prevented from calling the blocked number or numbers with the specified prefix.

枚举值:

inboundoutbound

comment

string

可选

Provide a comment to help you identify the blocked number or prefix.

<= 255 字符

string

可选

Unique identifier of the blocked list.

match_type

enum<string>

可选

Indicates the match type for the blocked list. The values can be one of the following:
phoneNumber: Indicates that only a specific phone number that is shown in the phone_number field is blocked.

prefix: Indicates that all numbers starting with prefix that is shown in the phone_number field are blocked.

枚举值:

phoneNumberprefix

phone_number

string

可选

The phone number to be blocked if you passed "phoneNumber" as the value for the match_type field. If you passed "prefix" as the value for the match_type field, provide the prefix of the phone number here including the country code. For example, entering 1905 blocks numbers with country code 1 and area code 905.

<= 50 字符

status

enum<string>

可选

Indicates whether the blocking is active or inactive.
active: The blocked list is active.
inactive: The blocked list is inactive.

枚举值:

activeinactive

next_page_token

string

可选

page_size

integer