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 the 'Staff' resource, specifically the 'Find Paged List' operation. It retrieves a paginated list of staff members based on various optional parameters such as search key, limit, skip, orderbys, and type. This is useful for managing and querying staff data efficiently, especially when dealing with large datasets where pagination and sorting are required.

Use Case Examples

  1. Retrieve a paginated list of staff members with a limit of 10 records per page, sorted by a specific field.
  2. Search staff members using a search key and skip the first 5 records to paginate results.
  3. Automatically count the total number of staff records while fetching a paged list.

Properties

Name Meaning
Auto Count Whether the total number of records is automatically counted (boolean). Defaults to false.
Limit The maximum number of records to retrieve per page (number). Defaults to 0, meaning no limit.
Orderbys Sorting criteria for the results, specified as multiple metadata values each with a field and order (ascending/descending).
Search Key A string used to filter the staff records by a search term.
Skip The number of records to skip for pagination purposes (number). Defaults to 0.
Type A string parameter to specify the type of staff records to retrieve.
Simplify Output Whether to simplify the output data structure (boolean). Defaults to false.

Output

JSON

  • id - Unique identifier of the staff member.
  • name - Name of the staff member.
  • email - Email address of the staff member.
  • phone - Phone number of the staff member.
  • position - Position or role of the staff member.
  • department - Department to which the staff member belongs.
  • otherProperties - Additional properties returned by the Yealink API for each staff record.

Dependencies

  • Yealink API
  • API authentication token (credential)

Troubleshooting

  • Ensure the 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 pagination parameters like 'limit' and 'skip', ensure they are set correctly to avoid empty or incomplete results.
  • If 'Simplify Output' is enabled but the output is not as expected, verify the API response structure and adjust accordingly.

Links

Discussion