3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve the latest Call Detail Records (CDR) and chat message timestamps. It is useful for scenarios where users want to monitor recent communication activities, such as calls and chats, within their 3CX environment. For example, a user might use this node to fetch the most recent call logs or chat messages to trigger follow-up actions or generate reports.

Properties

Name Meaning
Options A collection of query parameters to customize 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 wrapped in quotes automatically.
$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 specific properties to be returned, e.g., Id,Name.
$expand Expand related entities, e.g., RelatedEntity1,RelatedEntity2.

These options allow fine-grained control over the query sent to the 3CX API to list last CDR and chat message timestamps.

Output

The node outputs JSON data representing the list of last Call Detail Records and chat message timestamps retrieved from the 3CX system. The structure corresponds to the queried properties and may include metadata such as counts if requested.

If binary data were involved (e.g., recordings), it would be summarized here, but based on the provided code and properties, the output is purely JSON with communication record details.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials.
  • The base URL for the 3CX API must be set in the node credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the OAuth2 API credentials are correctly configured and valid.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other options can cause API errors. Validate these strings against 3CX API documentation.
  • Empty results: Check if the filters or search terms are too restrictive or if there are no recent records matching criteria.
  • API connectivity issues: Verify network access to the 3CX server URL and that the URL is correctly formatted without trailing slashes.

Links and References

Discussion