3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Update Phone Template" operation in the Phone Templates resource allows users to modify an existing phone template configuration within the 3CX telephony system. This node is useful for administrators who want to programmatically update settings such as allowed networks, codecs, ring tones, time formats, and other device-specific configurations for phones managed by 3CX.

Typical use cases include:

  • Updating phone templates to reflect new company policies or preferences.
  • Automating bulk updates of phone configurations across multiple devices.
  • Customizing phone behavior and appearance based on user roles or locations.

For example, an administrator could update a phone template to change the default queue ring tone or enable/disable SSL provisioning for enhanced security.

Properties

Name Meaning
Id The unique identifier of the phone template to update. Can be set via expression like {{$json.Id}}.
Add Allowed Boolean flag to allow adding this template.
Allowed Net Configs JSON array specifying allowed network configurations.
Allow SSL Provisioning Boolean indicating if SSL provisioning is permitted.
Backlight Timeouts JSON array defining backlight timeout settings.
Codecs JSON array listing supported audio codecs.
Content String content associated with the template.
Date Formats JSON array specifying date format options.
Default Queue Ring Tone String specifying the default ring tone for queues.
Hotdesking Allowed Boolean indicating if hotdesking (using any phone) is allowed.
Is Custom Boolean indicating if the template is custom.
Languages JSON array of supported languages.
Max Queue Custom Ringtones Number specifying maximum custom ringtones allowed in queues.
Models JSON array describing supported phone models.
Power Led Settings JSON array defining power LED behavior.
Queue Ring Tones JSON array of available queue ring tones.
Ring Tones JSON array of available ring tones.
Rps Enabled Boolean indicating if RPS (Remote Phone Setup) is enabled.
Screen Saver Timeouts JSON array defining screen saver timeout settings.
Template Type Option selecting the type of template: Preferred, Supported, Dedicated, Third Party, Deleted, Unknown.
Time Formats JSON array specifying time format options.
Time Zones JSON array specifying supported time zones.
URL String URL related to the template.
Xfer Type Enabled Boolean indicating if transfer type is enabled.

Output

The node outputs JSON data representing the updated phone template object as returned by the 3CX API. This typically includes all properties of the phone template after the update, reflecting the changes made.

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Invalid Id: If the provided template Id does not exist, the API will likely return an error. Verify the Id is correct and accessible.
  • Malformed JSON inputs: Properties expecting JSON arrays (e.g., AllowedNetConfigs, Codecs) must be valid JSON strings. Invalid JSON will cause parsing errors.
  • Permission issues: Ensure the API token has sufficient permissions to update phone templates.
  • Network errors: Confirm connectivity to the 3CX server and that the base URL is correctly configured without trailing slashes.
  • Unsupported template types: Using an invalid Template Type option may cause errors; use one of the predefined options.

Links and References

Discussion