Yealink icon

Yealink

Consume Yealink API (v.0.1.7)
Join our community

Actions13

Overview

This node interacts with the Yealink API to perform operations related to devices, specifically the 'Get Search List' operation under the 'Device' resource. It allows users to search for devices based on parameters such as MAC address, username, and region IDs, with additional optional fields to control pagination, ordering, and output simplification. This node is useful for scenarios where you need to retrieve detailed device information filtered by specific criteria, such as managing devices in different regions or searching by user account information.

Use Case Examples

  1. Retrieve a list of devices filtered by MAC address and username within specified regions.
  2. Use pagination and ordering options to manage large sets of device data efficiently.
  3. Simplify the output data for easier integration with other workflows or systems.

Properties

Name Meaning
Mac The MAC address of the device to search for.
Username The account information associated with the device.
Region IDs The list of site IDs (regions) to filter the device search.
Additional Fields Optional parameters including auto count, limit, orderbys (metadata fields and order), and skip for pagination and sorting control.
Simplify Output Whether to simplify the output data for easier consumption.

Output

JSON

  • id - Device identifier
  • mac - MAC address of the device
  • username - Username associated with the device
  • regionIds - List of region/site IDs associated with the device
  • additionalFields - Additional metadata fields returned from the API
  • autoCount - Indicates if total count is automatically calculated
  • limit - Maximum number of records returned per page
  • orderbys - Sorting order of the results based on metadata fields
  • skip - Number of records skipped in the search results
  • simplifyOutput - Flag indicating if the output data is simplified

Dependencies

  • Yealink API with API key credential

Troubleshooting

  • Common issues include incorrect or missing MAC address, username, or region IDs which will cause the API to return errors or empty results.
  • If the 'limit' and 'skip' parameters are not set when using regionIds, the API performance may degrade or the request may fail.
  • Errors from the API are thrown as NodeApiError with the error message from the Yealink API response.
  • Ensure the API credentials are correctly configured and have the necessary permissions to access device data.

Links

Discussion