3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

The "Create Fxs Template" operation in the "Fxs Templates" resource allows users to create a new FXS (Foreign Exchange Station) template within the 3CX telephony system. This node is useful for automating the provisioning and management of telephony device templates, especially when integrating with 3CX systems programmatically.

Typical use cases include:

  • Automating the creation of customized device templates for different brands or models.
  • Managing device configurations at scale by defining allowed network configurations, languages, time zones, and other parameters.
  • Enabling or disabling SSL provisioning and RPS (Remote Provisioning Server) features as part of the template setup.

For example, a telecom administrator could use this node to create a new FXS template that supports specific device models, languages, and network settings, streamlining deployment across multiple devices.

Properties

Name Meaning
Allowed Net Configs JSON array specifying allowed network configurations for the template.
Allow SSL Provisioning Boolean flag to enable or disable SSL provisioning for the template.
Brand String indicating the brand name associated with the template.
Content String content related to the template, possibly configuration data or descriptive text.
Device Type Option to select the device type; choices are "Fxs" or "Dect".
Id String identifier for the template.
Is Custom Boolean indicating whether the template is custom-created (true) or default (false).
Languages JSON array listing supported languages for the template.
Models JSON array describing device models compatible with the template.
Number Of Extensions Number specifying how many extensions the template supports.
Rps Enabled Boolean flag to enable or disable Remote Provisioning Server functionality.
Template Type Option selecting the template category; options include "Preferred", "Supported", "Dedicated", "Third Party", "Deleted", and "Unknown".
Time Zones JSON array specifying supported time zones for the template.
URL String URL related to the template, possibly for provisioning or reference.
Variables JSON array of variable objects, each potentially containing choices or configuration options.

Output

The node outputs JSON data representing the created FXS template object as returned by the 3CX API. This typically includes all properties sent during creation along with any additional metadata assigned by the server, such as unique IDs or status information.

If the node supports binary data output (not indicated here), it would represent files or attachments related to the template, but based on the provided information, output is JSON only.

Dependencies

  • Requires an active connection to a 3CX telephony system via its API.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be correctly set in the credentials.
  • The node uses HTTP requests with JSON payloads to interact with the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid JSON in properties: Since several properties expect JSON input (e.g., Allowed Net Configs, Languages, Models), ensure the JSON is well-formed. Malformed JSON will cause parsing errors.
  • Authentication errors: If the API key or OAuth2 token is missing or invalid, the node will fail to authenticate. Verify credentials and permissions.
  • Incorrect property values: Using unsupported values for options like Device Type or Template Type may result in API errors. Use only the documented options.
  • Network issues: Ensure the 3CX server URL is reachable from the n8n instance and that no firewall blocks the connection.
  • API endpoint changes: If the 3CX API version or endpoint changes, update the node configuration accordingly.

Links and References

Discussion