3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to list outbound rules configured in their 3CX environment. It is useful for scenarios where you want to retrieve and analyze outbound call routing rules, such as auditing call flows, integrating with other systems, or automating telephony management tasks.

For example, a user might want to fetch all outbound rules to display them in a dashboard or filter them based on certain criteria like status or creation date.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of outbound rules:
$top Show only the first n items (limit the number of results returned).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be auto-quoted.
$filter Filter items by property values (e.g., State eq 'Connected').
$count Include count of items (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).

Output

The node outputs JSON data representing the list of outbound rules retrieved from the 3CX API. Each item corresponds to an outbound rule with its properties as returned by the API, potentially filtered or shaped according to the input options.

If binary data were involved, it would be summarized here, but this node deals solely with JSON data.

Dependencies

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

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed $filter or $orderby) may result in API errors.
    • Network connectivity problems to the 3CX server can cause request timeouts or failures.

  • Error messages:

    • Authentication errors typically indicate invalid or expired credentials; recheck and update the API key/token.
    • Query parameter errors usually come with descriptive messages from the API; verify syntax and allowed values.
    • Connection errors suggest checking network access and the correctness of the server URL.

Links and References

Discussion