3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list chat messages history views. It is useful for scenarios where users want to retrieve historical chat message data from their 3CX system, such as for auditing, reporting, or monitoring communication logs.

For example, a user might use this node to:

  • Retrieve the latest 50 chat messages exchanged in the system.
  • Search chat messages containing specific keywords.
  • Filter chat messages by status or date.
  • Order chat messages by creation date or sender.
  • Expand related entities to get more detailed information about each chat message.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of chat messages history:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (offset for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be automatically quoted.
$filter Filter items by property values (e.g., State eq 'Connected').
$count Include count of items (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select 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 chat messages history views retrieved from the 3CX system. The structure typically includes an array of chat message objects with properties depending on the selected fields and expansions.

If binary data were involved (not indicated here), it would represent attachments or media related to chat messages, 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

  • Authentication errors: Ensure that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other options may cause API errors. Validate these parameters against 3CX API documentation.
  • Empty results: Check if filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL.

Links and References

Discussion