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 download chat messages history. This operation is useful for retrieving historical chat data from the 3CX platform, which can be beneficial for auditing, reporting, or integrating chat logs into other systems.

A practical example would be a customer support team wanting to export chat conversations for quality assurance or compliance purposes. By specifying filters and search criteria, users can tailor the data retrieval to their needs.

Properties

Name Meaning
Client Time Zone The time zone of the client making the request, used to correctly interpret date/time values.
Options A collection of optional query parameters to refine the data retrieval:
- Top Show only the first n items.
- Skip Skip the first n items.
- 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).
- Select Select specific properties to be returned (comma-separated list).
- Orderby Order items by property values (e.g., Name desc, CreatedAt asc).
- Expand Expand related entities (comma-separated list).

Output

The node outputs JSON data representing the downloaded chat messages history. The structure corresponds to the queried chat message records, including any selected fields and expanded related entities as specified in the options.

If binary data were involved (not indicated here), it would typically represent file attachments or exports, but this node focuses on JSON data output.

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 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 to the 3CX server will prevent data retrieval.

  • Error messages:

    • Authentication errors usually indicate invalid or expired credentials; reconfigure the API key.
    • Query syntax errors should be checked against 3CX API documentation for correct OData query formatting.
    • Timeout or connection errors suggest network issues or incorrect server URL configuration.

Links and References

Discussion