3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing functionality to download call history data. It is useful for scenarios where users want to retrieve detailed records of phone calls made or received through 3CX, such as for reporting, analytics, auditing, or customer service follow-up.

A practical example would be a customer support team automatically downloading recent call logs to analyze call durations and outcomes, or a manager generating reports on call volumes filtered by specific criteria.

Properties

Name Meaning
Options A collection of query parameters to customize the call history retrieval:
- Top: Show only the first n items
- Skip: Skip the first n items
- Search: Search items by search phrases (supports phrase quoting)
- Filter: Filter items by property values (e.g., State eq 'Connected')
- Count: Include count of items (boolean)
- Select: Select properties to be returned (comma-separated list, e.g., Id,Name)
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc)
- Expand: Expand related entities (comma-separated list of related entities to include)

Output

The node outputs JSON data representing the downloaded call history records from the 3CX system. Each item in the output corresponds to a call record with properties depending on the selected fields ($select) or default response from the API.

If binary data were involved (e.g., recordings), it would be indicated here, but based on the provided code and properties, the output is purely JSON structured call history data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, configured in the credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common issues:
    • Incorrect or missing API authentication token will cause authorization errors.
    • Invalid filter or query syntax may result in API errors or empty results.
    • Network connectivity problems to the 3CX server can cause request failures.
  • Error messages:
    • Authorization errors typically indicate invalid or expired credentials; re-authenticate or update credentials.
    • Query parameter errors suggest malformed $filter, $orderby, or other options; verify syntax against 3CX API documentation.
    • Timeout or connection errors require checking network access and server availability.

Links and References

Discussion