PATCH /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 update information on the blocked list.
Prerequisites:
- Pro or higher account plan with Zoom phone license
Scope:phone:write:admin
Rate Limit Label:Light
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
blockedListId |
String | Yes |
Unique Identifier of the blocked list. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
comment |
String | No |
Provide a comment to help you identify the blocked number or prefix. |
match_type |
String | No |
Specify the match type for the blocked list. The values can be one of the following: Valid values:
|
status |
String | No |
Enable or disable the blocking. One of the following values are allowed: Valid values:
|
block_type |
String | No |
State whether you want the block type to be inbound or outbound. Valid values:
|
phone_number |
String | No |
The phone number to be blocked if you passed "phoneNumber" as the value for the |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.