3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing an operation to finalize trunk provisioning. This operation is useful in scenarios where a user needs to complete the setup or configuration of telephony trunks within 3CX, ensuring that all necessary routing rules, groups, and phone numbers are properly defined and applied.

Practical examples include:

  • Completing the setup of new SIP trunks after initial creation.
  • Applying complex routing rules and group permissions to trunks.
  • Automating the final step in trunk provisioning workflows within telephony management processes.

Properties

Name Meaning
Model A JSON object defining the full configuration model for the trunk provisioning. It includes routing rules such as DefaultRule (with HolidaysDestination, Hours, OfficeHoursDestination, OutOfOfficeHoursDestination, TrunkDN), Groups (with GroupRights, Rights, Tags, Type), and PhoneNumbers. The property expects a JSON string which will be parsed and sent as the request body.

Output

The node outputs JSON data representing the response from the 3CX API after attempting to finalize the trunk provisioning. This typically includes confirmation of the applied configuration, status messages, or error details if the operation failed.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in the credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Invalid or malformed JSON in the "Model" property can cause parsing errors or API rejections.
    • Incorrect or missing API authentication credentials will result in authorization errors.
    • Network connectivity problems to the 3CX server can cause request failures.

  • Error messages:

    • Authentication errors typically indicate invalid or missing API keys; verify credentials.
    • Validation errors from the API may indicate incorrect structure or missing required fields in the "Model" JSON.
    • Timeout or connection errors suggest network issues or incorrect server URL configuration.

Links and References

Discussion