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 list call history views. It allows users to query and retrieve records of past calls with various filtering, searching, and sorting options. This is useful for scenarios such as generating call reports, monitoring call activity, or integrating call data into other workflows.

For example, a user might want to fetch the last 10 calls made today, filter by call state (e.g., connected), or search for calls involving a specific phone number or contact name.

Properties

Name Meaning
Options A collection of optional query parameters to customize the call history retrieval:
$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 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.

Output

The node outputs JSON data representing the list of call history records retrieved from the 3CX system. Each item corresponds to a call record with properties depending on the selected fields and expansions.

If binary data were involved (e.g., call recordings), it would be included separately, but this operation focuses on listing call metadata only.

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

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 can prevent access to the 3CX server.

  • Error messages:

    • Authentication errors typically indicate invalid or expired API tokens; reconfigure credentials.
    • Query syntax errors suggest checking the formatting of filter, search, or orderby strings.
    • Timeout or connection errors require verifying network access and server availability.

Links and References

Discussion