List phone users - Zoom API

List all the users on an account who have been assigned Zoom Phone licenses.

Prerequisites:

Pro or higher plan with Zoom phone license
Scope: phone:read:admin
Rate Limit Label: Light

{ "next_page_token": "", "page_size": 30, "total_records": 1, "users": [ { "calling_plans": [ { "name": "US/CA Unlimited Calling Plan", "type": 200 } ], "email": "sghhgghf@ghghmail.com", "extension_number": 10000, "id": "z8ghgfh8uQ", "name": "Shri Shri", "phone_user_id": "EMhghghg5w", "site": { "id": "CESEpjWwT-upVH7kt_ixWA", "name": "Main Site" }, "status": "activate" } ] }

请求参数

Query 参数

page_size

integer

可选

The number of records returned from a single API call.

<= 100

默认值:

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.

site_id

string

可选

Unique Identifier of the site. This can be retrieved from the List Phone Sites API.

返回响应

🟢200**HTTP Status Code:** `200` **OK**<br> Phone users retrieved successfully.

application/json

Body

next_page_token

string

可选

page_size

integer

可选

The number of records returned from a single API call.

<= 100

默认值:

total_records

integer

可选

The total records found for this query.

users

array [object {8}]

可选

calling_plans

array [object {2}]

可选

string <email>

可选

Email address of the user.

extension_number

integer

可选

Extension number assigned to the user's Zoom phone number.

string

可选

Unique Identifier of the user (userId).

name

string

可选

Name of the user.

phone_user_id

string

可选

Zoom Phone Identifier of the user.

site

object

可选

status

string

可选

Displays the status of the user's Zoom Phone license. The value can be either of the following:
activate: Active Zoom phone user.
deactivate: User with Zoom phone license disabled. This type of user can't make or receive calls.