Yealink icon

Yealink

Consume Yealink API (v.0.1.7)
Join our community

Actions13

Overview

This node interacts with the Yealink API to perform various operations related to Yealink devices and services. Specifically, for the 'RPS Device' resource and 'Check Device' operation, it checks the status or details of a device using its MAC address. This is useful for network administrators or IT professionals managing Yealink devices, allowing them to verify device information or status remotely via the API.

Use Case Examples

  1. Check the status of a Yealink RPS device by providing its MAC address to ensure it is properly registered and functioning.
  2. Simplify the output data to get a concise response about the device status for easier integration with other systems.

Properties

Name Meaning
Mac The MAC address of the RPS device to check. This is a required string input used to identify the device in the API request.
Simplify Output A boolean flag to simplify the output data returned by the API. When true, the response is processed to be more concise and easier to handle.

Output

JSON

  • mac - The MAC address of the checked device.
  • status - The status or result of the device check operation.
  • otherProperties - Additional properties returned by the Yealink API about the device.

Dependencies

  • Requires an API key credential for Yealink API authentication to make authorized requests.

Troubleshooting

  • Common issues include providing an invalid or incorrectly formatted MAC address, which will cause the API to return an error.
  • Network connectivity issues or incorrect API credentials can lead to authentication failures or request timeouts.
  • If the API returns an error object, the node throws a NodeApiError with the error message; ensure the MAC address exists and the API endpoint is accessible.

Links

Discussion