Struct zoom_api::phone_devices::PhoneDevices

pub struct PhoneDevices {
    pub client: Client,
}

Fields

client: Client

Implementations

impl PhoneDevices

pub async fn list(
    &self,
    type_: ListPhoneDevicesType,
    next_page_token: &str,
    page_size: i64
) -> Result<Vec<ListPhoneDevicesResponse>>

List devices.

This function performs a GET to the /phone/devices endpoint.

List all the desk phone devices that are configured with Zoom Phone on an account.

Scopes: phone:read:admin
Rate Limit Label: Medium

Prerequisites:

• Pro or a higher account with Zoom Phone license
• Account owner or admin permissions

Parameters:

• type_: crate::types::ListPhoneDevicesType – State of the device. The value should be either assigned to list devices that have been assigned to user(s) or unassigned to list devices that have not yet been assigned to any user in the Zoom account.
• next_page_token: &str – 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: i64 – The number of records returned within a single API call.

pub async fn list_all(
    &self,
    type_: ListPhoneDevicesType
) -> Result<Vec<ListPhoneDevicesResponse>>

List devices.

This function performs a GET to the /phone/devices endpoint.

As opposed to list, this function returns all the pages of the request at once.

List all the desk phone devices that are configured with Zoom Phone on an account.

Scopes: phone:read:admin
Rate Limit Label: Medium

Prerequisites:

• Pro or a higher account with Zoom Phone license
• Account owner or admin permissions

pub async fn add(&self, body: &AddPhoneDeviceRequest) -> Result<()>

Add a device.

This function performs a POST to the /phone/devices endpoint.

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

pub async fn get_device(&self, device_id: &str) -> Result<GetDeviceResponse>

Get device details.

This function performs a GET to the /phone/devices/{deviceId} endpoint.

Get detailed information about a specific desk phone device.

Scopes: phone:write:admin
Rate Limit Label: Light

Prerequisites:

• Pro or a higher account with Zoom Phone license
• Account owner or admin permissions

Parameters:

• device_id: &str – Unique Identifier of the device.

pub async fn delete_device(&self, device_id: &str) -> Result<()>

Delete a device.

This function performs a DELETE to the /phone/devices/{deviceId} endpoint.

Remove a desk phone device from the Zoom Phone System Management.

Prerequisites:

• Pro or a higher account with Zoom Phone license
• Account owner or admin permissions
• Device must not have been assigned to a user.
  Scopes: phone:write:admin
  

Rate Limit Label: Light

Parameters:

• device_id: &str – Unique Identifier of the device.

pub async fn update_device(
    &self,
    device_id: &str,
    body: &UpdateDeviceRequest
) -> Result<()>

Update a device.

This function performs a PATCH to the /phone/devices/{deviceId} endpoint.

Update information of a desk phone device.

Prerequisites:

• Pro or a higher account with Zoom Phone license
• Account owner or admin permissions
  Scopes: phone:write:admin
  

Rate Limit Label: Light

Parameters:

• device_id: &str – Unique Identifier of the Device.