Yealink icon

Yealink

Consume Yealink API (v.0.1.7)
Join our community

Actions13

Overview

This node integrates with the Yealink API to manage devices, specifically allowing the addition of new devices. It is useful in scenarios where users need to register devices with specific MAC addresses, model IDs, and region IDs, along with optional additional details such as authentication credentials, device names, remarks, and staff associations. For example, it can be used in IT management workflows to automate the onboarding of new Yealink devices into a network.

Use Case Examples

  1. Adding a new Yealink device by specifying its MAC address, model ID, and region ID.
  2. Including additional authentication details and staff assignments when registering a device.
  3. Synchronizing a device with an RPS device during the addition process.

Properties

Name Meaning
Mac The list of the MAC addresses of the device(s) to add.
Model ID The model ID of the device to add.
Region ID The site or region ID where the device is located.
Additional Fields Optional additional device details such as authentication name, machine ID, password, phone name, remarks, server ID, staff IDs, staff metadata, synchronization flag, and unique server URL.
Simplify Output Flag to simplify the output data returned by the node.

Output

JSON

  • id - The unique identifier of the added device.
  • mac - The MAC address of the added device.
  • modelId - The model ID of the added device.
  • regionId - The region ID where the device is registered.
  • authName - The authentication account name if provided.
  • machineId - The serial number code if provided.
  • password - The authentication password if provided.
  • phone - The device name if provided.
  • remark - Any notes or remarks about the device.
  • serverId - The server ID if specified.
  • staffIds - List of account IDs that cannot be specified.
  • staffs - Account information with metadata such as line ID and staff ID.
  • syncRps - Indicates if the device is synchronized to the RPS device.
  • uniqueServerUrl - The unique server URL if specified.

Dependencies

  • Yealink API
  • An API key credential for Yealink API authentication

Troubleshooting

  • Ensure all required fields (Mac, Model ID, Region ID) are provided; missing these will cause errors.
  • Verify that the Region ID and Server ID values are valid and exist in the Yealink system.
  • If the API returns an error, check the error message for details such as authentication failure or invalid parameters.
  • Use the 'Simplify Output' option to reduce output complexity if the returned data is too verbose.

Links

Discussion