Yealink icon

Yealink

Consume Yealink API (v.0.1.7)
Join our community

Actions13

Overview

This node interacts with the Yealink API to retrieve alarm data. Specifically, the 'Get Alarms' operation under the 'Alarm' resource allows users to fetch alarm records based on various filter criteria such as alarm IDs, severity levels, regions, and more. This node is useful for monitoring and managing alarms in Yealink systems, enabling automation workflows to respond to alarm events or analyze alarm data.

Use Case Examples

  1. Fetch alarms filtered by specific alarm IDs to monitor critical events.
  2. Retrieve alarms with a certain severity level within a specific region for targeted alerting.
  3. Get a limited number of alarms sorted by a specified field to review recent alarm activity.

Properties

Name Meaning
Additional Fields Optional filters and parameters to refine the alarm query, including alarm IDs, severity levels, region IDs, search keys, limits, ordering, and more.
Simplify Output Boolean flag to simplify the output data structure for easier consumption.

Output

JSON

  • id - Unique identifier of the alarm.
  • severity - Severity level of the alarm.
  • regionId - Region identifier associated with the alarm.
  • name - Name or title of the alarm.
  • timestamp - Timestamp when the alarm was generated.
  • description - Detailed description of the alarm.

Dependencies

  • Yealink API

Troubleshooting

  • Ensure the Yealink API credentials are correctly configured and valid to avoid authentication errors.
  • If the API returns an error, check the error message for details such as invalid parameters or rate limits.
  • When using filters like alarm IDs or region IDs, ensure the IDs are correctly formatted and exist in the system.
  • If the output is not as expected, try enabling the 'Simplify Output' option to get a cleaner data structure.

Links

Discussion