3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve detailed call log data reports. It is designed to fetch call logs filtered by various criteria such as time periods, source and destination types, call types, and additional filtering options. This node is beneficial for users who want to analyze call activity, monitor communication patterns, or generate usage reports from their 3CX phone system.

Practical examples include:

  • Generating a report of all calls made within a specific date range.
  • Filtering call logs by source or destination extensions or numbers.
  • Retrieving only connected calls or calls matching certain statuses.
  • Paginating results or searching/filtering call logs based on custom queries.

Properties

Name Meaning
Period From Start date/time for the call log data retrieval (e.g., periodFrom=2023-01-01).
Period To End date/time for the call log data retrieval (e.g., periodTo=2023-01-31).
Source Type Numeric code representing the type of call source (e.g., extension, external number).
Source Filter Filter string to specify which sources to include (e.g., specific extension numbers).
Destination Type Numeric code representing the type of call destination.
Destination Filter Filter string to specify which destinations to include.
Calls Type Numeric code indicating the type of calls to retrieve (e.g., all calls, connected calls).
Call Time Filter Type Numeric code specifying how to filter calls by time (e.g., call start time, call end time).
Call Time Filter From Start date/time for the call time filter.
Call Time Filter To End date/time for the call time filter.
Hide Pcalls Boolean flag to exclude "Pcalls" (possibly internal or special call types) from results.
Options Collection of optional query parameters to refine the request:
- Top: Limit the number of returned items.
- Skip: Number of items to skip (for pagination).
- Search: Search phrase(s) to filter items.
- Filter: OData-style filter expression (e.g., State eq 'Connected').
- Count: Include count of total items in response.
- Select: Specify which properties to return (e.g., Id,Name).
- Orderby: Sort order of items (e.g., Name desc).
- Expand: Expand related entities in the response.

Output

The node outputs JSON data containing the retrieved call log entries matching the specified filters and options. The structure typically includes details about each call such as timestamps, source and destination identifiers, call status, duration, and other metadata provided by the 3CX API.

If binary data were involved (e.g., call recordings), it would be indicated here, but this node focuses on JSON call log 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 requests to the 3CX REST API endpoint /xapi/v1.
  • No additional external dependencies beyond the 3CX API and proper authentication.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats for period or call time filters may result in errors or empty responses.
    • Using unsupported numeric codes for source/destination/call types can lead to no data being returned.
    • Overly restrictive filters might yield empty datasets.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • HTTP 400 errors often mean malformed query parameters; verify date formats and filter syntax.
    • HTTP 404 or endpoint errors suggest incorrect base URL configuration.

  • Resolution tips:

    • Double-check all required fields are filled with valid values.
    • Use the "Options" collection carefully to paginate or filter results without excluding all data.
    • Consult 3CX API documentation for valid parameter values and formats.

Links and References

Discussion