3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system to retrieve activity logs within a specified date range and filtered by various parameters. It is useful for monitoring call activities, analyzing call severity, and auditing extension usage in a 3CX phone system environment. For example, a user can fetch all call logs for extension "101" between two dates, filtering by severity or specific call identifiers.

Properties

Name Meaning
Start Date The start date/time from which to begin retrieving activity logs.
End Date The end date/time until which to retrieve activity logs.
Extension The extension number (e.g., 101, 102, 999) for which to get activity logs.
Call Identifier or parameter related to the call to filter logs accordingly.
Severity The severity level of the log entries to filter by.
Options Additional query options to refine the results:
- Top Show only the first n items.
- Skip Skip the first n items.
- Search Search items by search phrases; supports phrase searching with quotes if needed.
- Filter Filter items by property values using expressions (e.g., State eq 'Connected').
- Count Include count of items in the response (boolean).
- Select Select specific properties to be returned (e.g., Id,Name).
- Orderby Order items by property values (e.g., Name desc, CreatedAt asc).
- Expand Expand related entities to include additional linked data.

Output

The node outputs JSON data containing the retrieved activity logs matching the specified criteria. Each item in the output represents an individual log entry with details such as timestamps, extension numbers, call information, and severity levels. The structure directly reflects the 3CX API response for activity logs.

If binary data were involved (not indicated here), it would typically represent media files or recordings associated with calls, but this node focuses on JSON log data.

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

Troubleshooting

  • Invalid Date Format: Ensure that the Start Date and End Date are provided in the correct format expected by the 3CX API.
  • Authentication Errors: Verify that the OAuth2 credentials are correctly set up and have sufficient permissions.
  • Empty Results: Check filters and search parameters; overly restrictive filters may return no data.
  • API Endpoint Issues: Confirm the server URL is correct and accessible from the n8n instance.
  • Query Parameter Errors: When using advanced options like $filter or $orderby, ensure syntax matches OData query standards used by 3CX.

Links and References

Discussion