Get blocked list details

GET

/phone/blocked_list/{blockedListId}

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 get information about a specific blocked list.
Prerequisites:

Pro or higher account plan with Zoom phone license
Scope: phone:read:admin

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

200 - response

{
    "block_type": "inbound",
    "comment": "Blocked all numbers starting with 0001",
    "id": "7bR_Ix4KSJS_heuPPKc0Zw",
    "match_type": "prefix",
    "phone_number": "0001",
    "status": "active"
}

请求参数

Path 参数

blockedListId

string

必需

Unique Identifier of the blocked list.

返回响应

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

application/json

Body

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 or the prefix number that is blocked based on the match_type.

<= 50 字符

status

enum<string>

可选

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

枚举值: