3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, allowing users to interact programmatically with its features. Specifically, the "Get Trunk By Number" operation retrieves details about a trunk line identified by its phone number in international format. This is useful for scenarios where you need to fetch configuration or status information about a specific trunk line within your 3CX setup, such as verifying trunk availability, checking routing settings, or managing call flows based on trunk properties.

Practical examples include:

  • Automatically retrieving trunk details before initiating calls.
  • Auditing or reporting on trunks configured in the 3CX system.
  • Integrating trunk data into CRM or helpdesk workflows.

Properties

Name Meaning
Number Phone number of the trunk in international format (e.g., +1234567890). Required input.

Output

The node outputs JSON data containing the details of the trunk associated with the provided phone number. The exact structure depends on the 3CX API response but typically includes trunk identification, status, and configuration parameters.

If the node supports binary data output, it would represent any associated media or files related to the trunk, but this is not indicated in the provided code.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials for 3CX.
  • The base URL for the 3CX server must be set in the node's credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Invalid or missing phone number format can cause the request to fail.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Network connectivity problems to the 3CX server may cause timeouts or unreachable errors.
    • If the specified trunk number does not exist, the API may return a not found error.

  • Error messages and resolutions:

    • 401 Unauthorized: Check that the OAuth2 credentials are correctly configured and valid.
    • 404 Not Found: Verify the phone number is correct and exists in the 3CX system.
    • 400 Bad Request: Ensure the phone number is in the correct international format.
    • Network Errors: Confirm the server URL is reachable and no firewall blocks the connection.

Links and References

Discussion