Create a blocked list

POST

/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 create a blocked list and add a number to that blocked list.
Prerequisites:

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

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

201 - response

{
  "id": "dhfhfhnim"
}

请求参数

Body 参数multipart/form-data

block_type

enum<string>

可选

State whether you want the block type to be inbound or outbound.
inbound: Pass this value to prevent the blocked number or prefix from calling in to phone users.
outbound: Pass this value to prevent phone users from calling the blocked number or prefix.

枚举值:

inboundoutbound

comment

string

可选

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

<= 255 字符

match_type

enum<string>

可选

Specify the match type for the blocked list. The values can be one of the following:

phoneNumber: Choose this option (Phone Number Match) if you want to block a specific phone number. Then, in the phone_number field, provide the phone number along with the country code.

prefix: Choose this option (Prefix Match) if you want to block all numbers with a specific country code and area code. Next, in the phone_number field, enter a country code as part of the prefix. For example, entering 1907 blocks numbers with country code 1 and area code 907.

枚举值:

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>

可选

Enable or disable the blocking. One of the following values are allowed:
active: Keep the blocking active.
inactive: Disable the blocking.

枚举值:

activeinactive