3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve E.164 settings. The "Get E 164 Settings" operation fetches configuration details related to E.164 numbering plans used in telephony. This is useful for scenarios where you need to programmatically access or audit phone number formatting and routing rules within a 3CX system.

Practical examples include:

  • Retrieving a list of E.164 settings to display or process in an automation workflow.
  • Filtering or searching specific E.164 configurations based on criteria such as state or name.
  • Paginating through large sets of E.164 settings using skip and top options.

Properties

Name Meaning
Options A collection of query parameters to customize the retrieval of E.164 settings:
$top Show only the first n items (pagination limit).
$skip Skip the first n items (pagination offset).
$search Search items by search phrases; supports phrase quoting if spaces are present.
$filter Filter items by property values, e.g., State eq 'Connected'.
$count Include count of items in the response (boolean).
$orderby Order items by property values, e.g., Name desc, CreatedAt asc.
$select Select specific properties to be returned, e.g., Id,Name.
$expand Expand related entities, e.g., RelatedEntity1,RelatedEntity2.

These options allow fine-grained control over which E.164 settings are retrieved and how they are presented.

Output

The node outputs JSON data representing the retrieved E.164 settings from the 3CX system. The structure typically includes an array of E.164 setting objects, each containing properties as requested via $select or all properties by default.

If the $count option is enabled, the output will also include the total count of matching items.

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData-like query options may cause errors. Validate these strings carefully.
  • Empty results: If no E.164 settings are returned, check filter/search criteria or verify that the 3CX system has relevant configurations.
  • Network issues: Verify connectivity to the 3CX server URL and that it is correctly set without trailing slashes.

Links and References

Discussion