Add a device - Zoom API

By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. Additionally, if a desk phone is required, use this API to add a desk phone and assign it to a user.

Prerequisites:

Pro or a higher account with Zoom Phone license

Account owner or admin permissions

Supported device
Scopes: phone:write:admin

Rate Limit Label: Light

请求参数

Body 参数multipart/form-data

assigned_to

string

可选

User ID or email address of the user to whom this device is to be assigned. The User ID and the email of the user can be retrieved using the List Users API.

display_name

string

必需

Display name of the desk phone.

<= 255 字符

mac_address

string

必需

The MAC address of the desk phone.

Note: If you're using a wireless phone, enter the wired MAC address, not the wireless MAC address.

正则匹配:

^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$

model

string

可选

Model name of the device.

<= 50 字符

type

string

可选

Manufacturer (brand) name of the device.

<= 50 字符

返回响应

🟢201**HTTP Status Code:** `201` **Created** Device added successfully.

application/json

Body

No schema defined

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `300` **Validation failed.** Phone manufacturer does not exist. Phone model does not exist. Phone manufacturer is not supported. **Error Code:** `400` The MAC Address

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `1001` User not found: {userId}