3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve Call Detail Record (CDR) settings. It is useful for users who want to programmatically access and manage telephony call data configurations within their workflows. Typical scenarios include monitoring call records, auditing call settings, or integrating telephony data into reporting systems.

For example, a user might use this node to fetch the current CDR settings filtered by certain criteria, such as only retrieving connected calls or limiting the number of records returned.

Properties

Name Meaning
Options A collection of query parameters to customize the retrieval of CDR settings:
- $top Show only the first n items
- $skip Skip the first n items
- $search Search items by search phrases
- $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)

These options allow fine-grained control over the data retrieved from the 3CX API, enabling filtering, sorting, pagination, and selection of specific fields or related entities.

Output

The node outputs JSON data representing the CDR settings retrieved from the 3CX system. The structure corresponds to the queried properties and expanded entities as specified in the input options.

If binary data were involved (not indicated here), it would typically represent files or media related to the CDRs, but this node focuses on JSON metadata.

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 HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters based on user input.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, search, or orderby syntax may cause API errors. Validate OData-like query strings carefully.
  • Empty results: Check if filters or search terms are too restrictive or if the CDR settings exist in the system.
  • Network issues: Verify connectivity to the 3CX server URL and that the server is reachable.

Links and References

Discussion