Logo
Zoom Public API Documentation

List blocked lists

GET {{baseUrl}}/phone/blocked_list?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&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

Scope: phone:read:admin

Rate Limit Label: Medium

 

Body PARAM

Key Datatype Required Description 
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
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": "test", "id": "2ypsHHwTTFK-fzZJkudYwA", "match_type": "prefix", "phone_number": "112", "status": "active" }, { "block_type": "inbound", "comment": "test", "id": "2ypsHHwTTFK-fzZJkudYwA", "match_type": "prefix", "phone_number": "112", "status": "active" } ], "next_page_token": "OvrVMfenVmKgsH0SqfWQ2jgUsHFGXeanCB2", "page_size": 30, "total_records": 1 }



Curl
curl -X GET 'https://api.zoom.us/v2/phone/blocked_list?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30?next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30' -H 'Accept: application/json'

ENDPOINTS