Yealink icon

Yealink

Consume Yealink API (v.0.1.7)

Actions13

Overview

This node integrates with the Yealink API to manage regions within a system. Specifically, the 'Add' operation under the 'Region' resource allows users to create a new region by specifying a parent site ID and a name, with optional additional fields such as a description. This node is useful for organizing and structuring sites or regions hierarchically in environments managed by Yealink devices or services.

Use Case Examples

  1. Adding a new region under an existing parent site to organize devices geographically.
  2. Creating a new site region with a descriptive label for better identification in a network management system.

Properties

Name Meaning
Parent ID The ID of the parent site under which the new region will be added.
Name The name of the new region or site to be created.
Additional Fields Optional additional information for the region, such as a description.
Simplify Output Whether to simplify the output data structure for easier consumption.

Output

JSON

  • id - The unique identifier of the newly created region.
  • parentId - The ID of the parent site under which the region was created.
  • name - The name of the newly created region.
  • description - The description of the region, if provided.

Dependencies

  • Yealink API

Troubleshooting

  • Ensure the 'parentId' provided exists and is valid; otherwise, the API call to add a region will fail.
  • Check that the API credentials for Yealink are correctly configured and have the necessary permissions to add regions.
  • If the node returns an error, verify the input parameters for correctness and completeness.
  • Network connectivity issues may prevent successful API calls; ensure the node can reach the Yealink API endpoint.

Links

Discussion