3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download reports on inbound calls. Specifically, the "Download Get Inbound Calls" operation under the "Report Inbound Calls" resource allows users to retrieve detailed call data for a specified time period and trunk DNS. This is useful for call center managers, telecom administrators, or business analysts who need to analyze inbound call traffic, monitor call quality, or generate usage reports.

Practical examples include:

  • Downloading inbound call logs for a specific date range to analyze peak call times.
  • Filtering calls by type or trunk DNS to identify issues or trends.
  • Exporting call data for integration with CRM or reporting tools.

Properties

Name Meaning
Period From Start date/time of the report period. Usage: periodFrom={periodFrom}
Period To End date/time of the report period. Usage: periodTo={periodTo}
Trunk Dns The DNS name of the trunk to filter inbound calls. Usage: trunkDns={trunkDns}
Calls Type Numeric code representing the type of calls to include. Usage: callsType={callsType}
Client Time Zone Time zone of the client making the request. Usage: clientTimeZone={clientTimeZone}
Options Additional query options to refine the request:
- Top Show only the first n items
- Skip Skip the first n items
- Search Search items by search phrases (supports phrase quoting)
- Filter Filter items by property values (e.g., State eq 'Connected')
- Count Include count of items (boolean)
- Select Select specific properties to be returned (comma-separated list)
- Orderby Order items by property values (e.g., Name desc, CreatedAt asc)
- Expand Expand related entities (comma-separated list)

Output

The node outputs JSON data containing the requested inbound call report information. The structure typically includes an array of call records matching the specified filters and options. Each record contains details such as call timestamps, caller IDs, call duration, call state, and other relevant metadata.

If binary data is included (not indicated in the provided source), it would represent downloadable files or attachments related to the call reports.

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 with appropriate headers.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats for Period From or Period To may result in errors or empty responses.
    • Providing invalid or unsupported values for Calls Type or Trunk Dns can lead to no data being returned.
    • Overly restrictive filters or search queries might return zero results.

  • Error Messages:

    • Authentication errors: Check that the API key and server URL are correctly configured.
    • Validation errors: Ensure required fields like Period From, Period To, Trunk Dns, Calls Type, and Client Time Zone are provided and correctly formatted.
    • API rate limits or server errors: Retry after some time or check server status.

Links and References

Discussion