3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically focusing on managing trunks and their phone numbers. The "Get Provider Available Phone Numbers" operation retrieves a list of phone numbers available from the provider that can be assigned or used within the 3CX system.

Common scenarios for this node include:

  • Automatically fetching available phone numbers from a telephony provider to assign them to trunks.
  • Integrating with 3CX to dynamically manage phone number inventory.
  • Synchronizing available phone numbers for provisioning or reporting purposes.

For example, a user might use this node to query which phone numbers are currently available from their telephony provider before assigning one to a new trunk configuration.

Properties

Name Meaning
Model A JSON object representing the request body model sent to the API. It includes configuration details such as rules, groups, and phone numbers. This JSON is parsed and sent in the request body.

The "Model" property expects a JSON structure that defines various routing rules, group rights, tags, types, and phone numbers. It allows detailed customization of the request payload when querying available phone numbers.

Output

The node outputs data in JSON format containing the response from the 3CX API about available phone numbers from the provider. The exact structure depends on the API response but typically includes details like phone number identifiers, status, capabilities, and other metadata relevant to each available phone number.

No binary data output is indicated for this operation.

Dependencies

  • Requires an OAuth2 API 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

  • Authentication errors: Ensure the OAuth2 credentials are correctly set up and valid. Expired or incorrect tokens will cause authentication failures.
  • Invalid JSON in Model property: Since the "Model" input expects a JSON string that is parsed, malformed JSON will cause parsing errors. Validate the JSON syntax before running the node.
  • API connectivity issues: Verify the 3CX server URL is reachable and correct. Network issues or incorrect URLs will prevent successful API calls.
  • Unexpected API responses: If the API changes or returns unexpected data, the node may not handle it properly. Check the 3CX API documentation for updates.

Links and References

Discussion