Yealink icon

Yealink

Consume Yealink API (v.0.1.7)
Join our community

Actions13

Overview

This node interacts with the Yealink API to manage devices, specifically supporting the 'Get Complex List' operation under the 'Device' resource. It allows users to retrieve a detailed list of devices with various filtering and sorting options. This is useful for scenarios where users need to fetch comprehensive device data, such as in network management or inventory systems. For example, users can search devices by region, model, or keywords, limit the number of results, and order the results by specific metadata fields.

Use Case Examples

  1. Retrieve all devices in specific regions with a limit on the number of results to ensure performance.
  2. Search devices by MAC address, IP, or device name using keywords.
  3. Get a simplified output of device data for easier processing in subsequent workflow steps.

Properties

Name Meaning
Additional Fields Optional parameters to refine the device list query, including auto count, limit, search key, model IDs, orderbys, region IDs, and skip count.
Return All Boolean flag to return all items without pagination.
Simplify Output Boolean flag to simplify the output data structure for easier consumption.

Output

JSON

  • ``
    • id - Unique identifier of the device.
    • mac - MAC address of the device.
    • modelId - Model identifier of the device.
    • regionId - Region or site identifier where the device is located.
    • name - Name of the device.
    • ip - IP address of the device.
    • status - Current status of the device.
    • additionalProperties - Other device-specific properties returned by the API.

Dependencies

  • Yealink API

Troubleshooting

  • Ensure that the API credentials are correctly configured and have the necessary permissions to access device data.
  • If the node returns an error related to missing parameters, verify that required fields like 'limit' and 'skip' are set when using region IDs to avoid performance issues.
  • Network connectivity issues may cause API request failures; ensure the network allows access to the Yealink API endpoints.
  • If the output is not as expected, try toggling the 'Simplify Output' option to see if the data structure better fits your workflow needs.

Links

Discussion