Yealink icon

Yealink

Consume Yealink API (v.0.1.7)
Join our community

Actions13

Overview

This node interacts with the Yealink API to retrieve a list of alarms based on specified criteria. It is useful for monitoring and managing alarms in a Yealink system, allowing users to filter alarms by various fields such as search keywords, module, severity, region IDs, and more. For example, it can be used to fetch alarms related to specific devices or regions, count alarms automatically, or order the results by certain metadata fields.

Use Case Examples

  1. Fetch a list of alarms filtered by severity and region to monitor critical issues in specific locations.
  2. Retrieve alarms with a search key matching a device name to quickly identify related alerts.
  3. Get a limited number of alarms ordered by timestamp to review recent events.

Properties

Name Meaning
Additional Fields Optional parameters to filter and customize the alarm list retrieval, including search key, auto count, limit, module, orderbys, region IDs, severities, severity, and skip count.
Simplify Output Whether to simplify the output data structure for easier consumption.

Output

JSON

  • ``
    • alarmId - Unique identifier of the alarm
    • severity - Severity level of the alarm
    • module - Module to which the alarm belongs
    • regionId - Region identifier associated with the alarm
    • timestamp - Timestamp when the alarm was generated
    • description - Description or details of the alarm

Dependencies

  • Yealink API

Troubleshooting

  • Ensure the Yealink API credentials are correctly configured and valid to avoid authentication errors.
  • Check that the API endpoint 'api/open/v1/manager/alarm/getList' is accessible and the network connection is stable.
  • Verify that the input parameters such as region IDs and severities are correctly formatted and valid to prevent request errors.
  • If the node returns an error with a message from the API, review the error details to adjust the request parameters accordingly.

Links

Discussion