3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node integrates with the 3CX telephony system, specifically providing functionality to list call recordings. It allows users to retrieve a collection of recording records from 3CX with various query options such as filtering, searching, ordering, and pagination. This is useful in scenarios where you want to automate the retrieval and processing of call recordings for reporting, quality assurance, or archival purposes.

For example, you could use this node to:

  • Fetch the latest 10 call recordings.
  • Search recordings by specific keywords or metadata.
  • Filter recordings based on their state or date.
  • Retrieve only selected properties of recordings to optimize data usage.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of recordings:
$top Show only the first n items (limit the number of recordings 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 to include total count in response).
$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 output JSON contains an array of recording objects retrieved from the 3CX API according to the specified query options. Each object represents a recording with its properties as returned by the API. The exact structure depends on the $select and $expand options used.

If the node supports binary data output (not explicitly shown in the provided code), it would typically represent actual audio files or media content of the recordings. However, based on the given information, the output focuses on JSON metadata about recordings.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node uses the 3CX REST API endpoint /xapi/v1 to fetch recordings.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common issues:

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

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Query syntax errors should be checked against 3CX API documentation for correct OData query formatting.
    • Server errors might require checking the 3CX server status or logs.

Links and References

Discussion