3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download call log data reports. It is designed to retrieve detailed call logs filtered by various criteria such as time periods, source and destination types, call types, and more. This functionality is useful for businesses or administrators who need to analyze call activity, generate usage reports, or audit communications within their 3CX phone system.

Typical use cases include:

  • Downloading call logs for a specific date range to analyze call volume.
  • Filtering calls by source or destination to focus on particular extensions or external numbers.
  • Applying time filters to narrow down calls within certain hours.
  • Excluding certain call types (e.g., PC calls) from the report.
  • Paginating results or searching/filtering further using OData-like query options.

Properties

Name Meaning
Period From Start date/time of the period for which to download call logs (format expected by API).
Period To End date/time of the period for which to download call logs.
Source Type Numeric code representing the type of source filter applied to calls (e.g., extension, group).
Source Filter String filter value specifying the source criteria (e.g., extension number or pattern).
Destination Type Numeric code representing the type of destination filter applied to calls.
Destination Filter String filter value specifying the destination criteria.
Calls Type Numeric code indicating the type of calls to include (e.g., all calls, inbound, outbound).
Call Time Filter Type Numeric code defining how to apply the call time filter (e.g., call start time, answer time).
Call Time Filter From Start time for the call time filter.
Call Time Filter To End time for the call time filter.
Hide Pcalls Boolean flag to exclude PC calls from the results.
Client Time Zone Time zone string to interpret date/time values correctly in the client context.
Options Collection of optional OData-like query parameters to control pagination, filtering, sorting, and selection:
- Top: Limit number of items returned.
- Skip: Number of items to skip.
- Search: Search phrase.
- Filter: Filter expression.
- Count: Include count of total items.
- Select: Properties to return.
- Orderby: Sort order.
- Expand: Related entities to expand.

Output

The node outputs JSON data containing the downloaded call log records matching the specified filters and options. The structure typically includes an array of call log entries, each with properties describing the call details such as timestamps, source, destination, call duration, call type, and other metadata provided by the 3CX API.

If binary data were involved (e.g., recordings), it would be indicated here, but based on the provided information, the output is purely JSON-formatted call log data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system's API.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node uses HTTP requests to the 3CX API endpoint /xapi/v1 with JSON responses.
  • No additional external dependencies beyond the 3CX API and n8n's HTTP request capabilities.

Troubleshooting

  • Invalid Date/Time Format: Ensure that Period From, Period To, Call Time Filter From, and Call Time Filter To are provided in the correct format expected by the 3CX API (usually ISO 8601).
  • Authentication Errors: Verify that the API key credential is valid and has sufficient permissions to access call log data.
  • Empty Results: Check filter criteria; overly restrictive filters may result in no data returned.
  • API Rate Limits or Timeouts: Large queries might time out or hit rate limits; use pagination options (Top, Skip) to limit data size.
  • Incorrect Numeric Codes: For properties like Source Type, Destination Type, Calls Type, and Call Time Filter Type, ensure the numeric codes correspond to valid values defined by the 3CX API documentation.

Links and References

Discussion