Yealink icon

Yealink

Consume Yealink API (v.0.1.7)
Join our community

Actions13

Overview

This node interacts with the Yealink API to manage staff-related SIP (Session Initiation Protocol) configurations. Specifically, the 'Add Sip' operation allows users to add a new SIP registration for a staff member by providing necessary SIP details such as register name, username, password, SIP server addresses, and ports. This is useful in scenarios where an organization needs to programmatically configure SIP accounts for staff devices, enabling VoIP communication setups.

Use Case Examples

  1. Adding a new SIP registration for a staff member by specifying SIP register name, username, password, primary and secondary SIP servers, and ports.
  2. Automating the provisioning of SIP accounts for multiple staff members in a call center environment.

Properties

Name Meaning
SIP Register Name The SIP registration name used for the staff's SIP account.
Username The username for the SIP account.
Password The password for the SIP account.
SIP Server1 The primary SIP server address.
SIP Port 1 The port number for the primary SIP server.
Additional Fields Optional additional SIP configuration fields such as SIP Display Name, SIP Label, secondary SIP server and port, type, remark, and region ID.
Simplify Output If enabled, simplifies the output data structure for easier consumption.

Output

JSON

  • sipRegisterName - The SIP registration name of the added SIP account.
  • username - The username of the added SIP account.
  • sipServer1 - The primary SIP server address used.
  • sipPort1 - The port number for the primary SIP server.
  • sipDisplayName - Optional display name of the SIP account if provided.
  • sipLabel - Optional label of the SIP account if provided.
  • sipServer2 - Optional secondary SIP server address if provided.
  • sipPort2 - Optional port number for the secondary SIP server if provided.
  • type - Optional type field of the SIP account if provided.
  • remark - Optional remark or note about the SIP account if provided.
  • regionId - Optional region identifier associated with the SIP account if provided.

Dependencies

  • Yealink API

Troubleshooting

  • Common issues include incorrect or missing required SIP parameters such as SIP Register Name, Username, Password, SIP Server1, or SIP Port1, which will cause the API request to fail.
  • API errors returned from the Yealink API are thrown as NodeApiError; ensure that the API credentials are valid and have the necessary permissions.
  • Network connectivity issues to the Yealink API endpoint can cause request failures; verify network access and API endpoint availability.

Links

Discussion