3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to update phone-related settings within the system. It is useful for administrators who want to programmatically manage and configure phone provisioning and behavior settings such as ringtone options, firmware cleanup, device update intervals, and provisioning security.

Typical use cases include:

  • Automating the configuration of multiple phones in a 3CX environment.
  • Adjusting update intervals for different phone brands to optimize network usage.
  • Enabling or disabling multi-firmware support and provisioning secrets for enhanced security.
  • Customizing Do Not Disturb (DND) profiles across devices.

For example, an administrator could use this node to set all phones to allow multiple queue ringtones and specify custom update intervals for Yealink and Grandstream devices.

Properties

Name Meaning
Allow Multi Queue Ringtones Enable or disable multiple queue ringtones on phones (boolean: true or false).
Auto Cleanup Firmware Enable or disable automatic cleanup of old firmware versions on phones (boolean).
Custom DND Profile Specify a custom Do Not Disturb profile by name or identifier (string).
Fanvil Update Interval Set the update interval (in minutes) for Fanvil brand phones (number).
Grandstream Update Interval Set the update interval (in minutes) for Grandstream brand phones (number).
Phone Allow Multi Firmwares Allow or disallow multiple firmware versions on phones (boolean).
Snom Update Interval Set the update interval (in minutes) for Snom brand phones (number).
Use Provisioning Secret Enable or disable the use of a provisioning secret for phone configuration (boolean).
Use Rpc For Local Phones Enable or disable RPC communication for local phones (boolean).
Yealink Update Interval Set the update interval (in minutes) for Yealink brand phones (number).

Output

The node outputs JSON data representing the result of the update operation on the phone settings. This typically includes confirmation of the updated settings or any relevant response from the 3CX API indicating success or failure.

No binary data output is expected from this node.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests to the 3CX API.
  • The base URL for the 3CX server must be provided in the credentials configuration.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 to perform updates.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 credentials are correctly configured and have sufficient permissions to update phone settings.
  • Invalid property values: Verify that numeric fields like update intervals are non-negative numbers and boolean fields are properly set.
  • Network issues: Confirm that the 3CX server URL is reachable from the n8n instance and that no firewall or proxy blocks the requests.
  • API errors: If the 3CX API returns errors, check the error message for details; it may indicate invalid parameters or unsupported operations.

Links and References

Discussion