Yealink icon

Yealink

Consume Yealink API (v.0.1.7)

Actions13

Overview

This node interacts with the Yealink API to perform batch deletion of devices. It allows users to specify multiple device IDs or MAC addresses to delete devices in bulk. Additional options include synchronizing the deletion with RPS devices and deciding whether to delete RPS devices simultaneously. This operation is useful for managing large sets of devices efficiently, such as in IT asset management or network administration scenarios where multiple devices need to be removed at once.

Use Case Examples

  1. Deleting multiple devices by specifying their device IDs.
  2. Deleting devices by providing a list of MAC addresses.
  3. Choosing to synchronize device deletion with RPS devices or not.

Properties

Name Meaning
DeviceIds IDs The list of device IDs to be deleted, specified as multiple values of device ID strings.
Sync RPS Boolean flag indicating whether to synchronize the device deletion with the RPS device. Defaults to true.
Macs The list of MAC addresses of devices to be deleted, specified as multiple values of MAC address strings.
Delete RPS Boolean flag indicating whether to delete RPS devices simultaneously. Defaults to true.
Simplify Output Boolean flag to simplify the output data structure for easier consumption.

Output

JSON

  • deviceIds - List of device IDs that were requested to be deleted.
  • macs - List of MAC addresses that were requested to be deleted.
  • syncRps - Indicates if synchronization with RPS device was performed.
  • deleteRps - Indicates if RPS devices were deleted simultaneously.
  • result - Response from the Yealink API indicating the success or failure of the batch delete operation.

Dependencies

  • Yealink API with appropriate API key credentials

Troubleshooting

  • Ensure that the device IDs or MAC addresses provided are valid and exist in the Yealink system to avoid errors.
  • If the API returns an error, check the error message for details such as permission issues or invalid parameters.
  • Verify that the API credentials are correctly configured and have the necessary permissions to perform batch deletions.
  • If synchronization with RPS devices is enabled, ensure that the RPS devices are properly configured and accessible.

Links

Discussion