3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to list chat history views. It allows users to retrieve a collection of chat history records with various query options such as filtering, searching, ordering, and pagination. This is useful in scenarios where you want to analyze or process historical chat data from 3CX, for example, generating reports on chat interactions, monitoring communication trends, or integrating chat logs into other systems.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list of chat history views returned:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not already quoted, it will be automatically quoted.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of total items matching the query (boolean).
$orderby Order items by specified property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (e.g., Id,Name).
$expand Expand related entities to include additional linked data (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the list of chat history view items retrieved from the 3CX API. The structure corresponds to the queried chat history records, potentially including expanded related entities if requested. If the $count option is enabled, the output will also include the total count of matching items.

No binary data output is indicated.

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 credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

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 can prevent access to the 3CX server.
  • Error messages:
    • Authentication errors typically indicate invalid or expired credentials; verify and update the API key.
    • Query syntax errors suggest incorrect use of OData query options; review the filter, search, and orderby expressions.
    • Timeout or connection errors require checking network settings and server availability.

Links and References

Discussion