3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system to retrieve reports on inbound calls. Specifically, the "Get Inbound Calls" operation under the "Report Inbound Calls" resource allows users to fetch detailed call data within a specified time period and filtered by various criteria such as trunk DNS and call type.

This node is beneficial in scenarios where businesses need to analyze their inbound call traffic for performance monitoring, billing, or operational insights. For example, a contact center manager might use this node to generate reports on call volumes during peak hours or to identify patterns in call handling.

Properties

Name Meaning
Period From The start date/time of the reporting period (usage: periodFrom={periodFrom}).
Period To The end date/time of the reporting period (usage: periodTo={periodTo}).
Trunk Dns The DNS identifier of the trunk to filter inbound calls (usage: trunkDns={trunkDns}).
Calls Type Numeric value representing the type of calls to include (usage: callsType={callsType}).
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.
- Filter Filter items by property values (e.g., State eq 'Connected').
- Count Include count of items (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 (e.g., RelatedEntity1,RelatedEntity2).

Output

The output JSON contains the retrieved inbound call report data from the 3CX system according to the specified filters and options. The structure typically includes details about each call such as timestamps, call duration, caller information, call state, and other relevant metadata depending on the selected properties.

If binary data were involved (e.g., recordings), it would be summarized accordingly, but based on the provided code and properties, the output focuses on JSON-formatted call report data.

Dependencies

  • Requires an API authentication token credential to connect securely to the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers (Accept: application/json).

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats for Period From or Period To may result in errors or empty responses.
    • Using unsupported or incorrect values for Calls Type or other filters can lead to no data being returned.
    • Network connectivity issues between n8n and the 3CX server can cause request failures.

  • Error Messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Validation errors on input parameters suggest checking the format and required fields.
    • API rate limiting or server errors should be handled by retrying after some delay or contacting the 3CX administrator.

Links and References

Discussion