Get user's profile

GET

/phone/users/{userId}

Retrieve a user's zoom phone profile.

Scopes: phone:read, phone:read:admin
Rate Limit Label: Light

Prerequisites :

Business or Enterprise account

A Zoom Phone license

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

200 - response

{
    "calling_plans": [
        {
            "type": 200
        }
    ],
    "email": "awesome@amazingemailservice.com",
    "extension_number": 100100,
    "id": "fdjbgdfgkl0-ibkdjfg20913",
    "phone_numbers": [
        {
            "id": "vigfkjnrtUernketg09",
            "number": "+1234567890"
        }
    ],
    "phone_user_id": "vfjbdlgrwi902_igr",
    "site_id": "aXb1039sdjhhgdbgj4",
    "status": "activate"
}

请求参数

Path 参数

userId

string

必需

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

返回响应

🟢200**HTTP Status Code:** `200` <br>User profile object returned.

application/json

Body

Zoom User Profile

calling_plan

array [object {1}]

可选

Calling Plan of the user

type

integer

可选

The type of calling plan.

string

可选

Email address of the user.

extension_number

integer

可选

Extension number

string

可选

Zoom User Id.

phone_numbers

array [object {2}]

可选

string

可选

Phone Number Id

number

string

可选

Phone number

phone_user_id

string

可选

Zoom Phone User Id.

site_admin

boolean

可选

Indicates whether the user is a site admin or not.

site_id

string

可选

Unique Identifier of a site.

status

enum<string>

可选

The status of the user.
activate: An active user.
deactivate: User has been deactivated from the ZoomPhone system.

枚举值:

activatedeactivate

🔵300**Error code:** `300` <br> User does not belong to this account.

🟠404**HTTP Status Code:** `404`<br> **Error code**: `1001` <br>User does not exist: {userId}.

修改于 2024-04-24 09:06:48

List phone users

Update user's profile