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 history data. This operation is useful for retrieving historical chat records from the 3CX system, which can be used for auditing, reporting, or integrating chat data into other workflows or systems.

A practical example would be a customer support team wanting to export chat conversations for quality assurance or compliance purposes. Another scenario could be automating the archival of chat histories on a scheduled basis.

Properties

Name Meaning
Client Time Zone The time zone of the client making the request, required to correctly interpret date/time data.
Options A collection of optional query parameters to customize the data retrieval:
- Top Show only the first n items (limit results).
- Skip Skip the first n items (offset results).
- 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 history records. Each item corresponds to a chat record with properties as specified or filtered by the input options. The output structure depends on the selected fields and filters but generally includes chat metadata such as timestamps, participants, message content, and status.

If binary data were involved (e.g., attachments), it would be included accordingly, but this node focuses on JSON chat history data.

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 with appropriate headers.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and server URL are correctly configured.
  • Incorrect time zone format: The Client Time Zone must be provided accurately to avoid misinterpretation of date/time fields.
  • Invalid filter or query syntax: Filters and queries must follow the expected OData-like syntax; otherwise, the API may return errors.
  • Empty or no results: Check if the filters or search terms are too restrictive or if the chat history exists for the given criteria.
  • Network issues: Verify connectivity to the 3CX server and that the server URL is reachable.

Links and References

Discussion