Yealink icon

Yealink

Consume Yealink API (v.0.1.7)
Join our community

Actions13

Overview

This node allows editing a device in the Yealink system by updating its properties such as authentication details, machine ID, phone name, remarks, server association, staff assignments, synchronization settings, and unique server URL. It is useful for managing device configurations in an enterprise environment where Yealink devices are deployed, enabling administrators to keep device information up to date and synchronized with other systems.

Use Case Examples

  1. Updating the authentication name and password of a device to ensure secure access.
  2. Changing the region or server ID associated with a device to reflect its new physical location or server management.
  3. Adding or modifying staff assignments linked to a device to control user access and display order on the device screen.

Properties

Name Meaning
ID The unique identifier of the device to be edited.
Region ID The site or region identifier where the device is located.
Auth Name The account name used for device authentication.
Machine ID The serial number (SN) code of the device.
Password The password used for device authentication.
Phone The name assigned to the device.
Remark Additional notes or comments about the device.
Server ID The identifier of the server associated with the device.
Staff IDs A list of account IDs that are restricted or cannot be specified for the device.
Staffs Detailed account information that can be specified for the device, including line ID and staff ID.
Sync RPS A boolean flag indicating whether to synchronize the device with the RPS device.
Unique Server URL A unique URL for the server associated with the device.
Simplify Output Whether to simplify the output data returned by the node.

Output

JSON

  • id - The device ID.
  • regionId - The region or site ID of the device.
  • authName - The authentication account name.
  • machineId - The serial number of the device.
  • password - The authentication password.
  • phone - The device name.
  • remark - Notes or remarks about the device.
  • serverId - The server ID associated with the device.
  • staffIds - List of account IDs that are restricted.
  • staffs
    • metadataValues
      * lineId - The display order line ID for staff on the device screen.
      * staffId - The staff account ID.
  • syncRps - Flag indicating synchronization with RPS device.
  • uniqueServerUrl - The unique server URL for the device.

Dependencies

  • Yealink API (v.1)

Troubleshooting

  • Ensure the device ID and region ID are correctly specified; missing or incorrect IDs will cause API errors.
  • If the API returns an error, check the authentication credentials for the Yealink API are valid and have the necessary permissions.
  • When using collections like staff IDs or staffs, ensure the data structure matches the expected format to avoid request failures.
  • If the output is not as expected, try toggling the 'Simplify Output' option to see the full response for debugging.

Links

Discussion