3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node allows users to create a new phone template in the 3CX telephony system. Phone templates define configuration settings and behaviors for phones managed by 3CX, such as allowed codecs, ring tones, time zones, and provisioning options. This operation is useful when automating the setup of phone configurations or managing multiple phone models with specific settings.

Practical examples include:

  • Automatically creating custom phone templates for different office locations.
  • Defining allowed codecs and network configurations for specific phone models.
  • Setting up default ring tones and screen saver timeouts for user devices.

Properties

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

Output

The node outputs JSON data representing the created phone template object as returned by the 3CX API. This typically includes all properties of the newly created template such as its ID, configuration details, and status.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node uses the base URL configured in the credentials to send requests to the 3CX API endpoint /xapi/v1.
  • Proper permissions on the 3CX system are necessary to create phone templates.

Troubleshooting

  • Invalid JSON in properties: Many properties expect JSON arrays. Ensure that JSON inputs are correctly formatted; otherwise, parsing errors may occur.
  • Authentication errors: Verify that the API key or OAuth2 token is valid and has sufficient permissions.
  • Missing required fields: Some fields like Id or TemplateType might be mandatory depending on the 3CX API version; ensure these are provided.
  • API endpoint issues: Confirm the base URL is correct and accessible from n8n.
  • Unexpected response structure: If the API changes, the node might not parse responses correctly; check for updates or API documentation changes.

Links and References

Discussion