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 quality reports. Specifically, the "Get Call Quality Report" operation under the "Report Call Log Data" resource fetches metrics and data related to a particular call's quality based on identifiers such as call IDs and phone numbers.

Typical use cases include:

  • Monitoring call quality for troubleshooting or analytics.
  • Integrating call quality data into dashboards or reporting tools.
  • Automating alerts or workflows based on call quality metrics.

For example, a user might input specific call identifiers to obtain jitter, packet loss, or latency statistics for a given call, helping diagnose network or hardware issues affecting call performance.

Properties

Name Meaning
Cdr Id The unique Call Detail Record identifier for the call. Usage format: cdrId={cdrId}
Src Number The source phone number involved in the call. Usage format: srcNumber={srcNumber}
Dst Number The destination phone number involved in the call. Usage format: dstNumber={dstNumber}
Src Caller Id The caller ID of the source party. Usage format: srcCallerId={srcCallerId}
Dst Caller Id The caller ID of the destination party. Usage format: dstCallerId={dstCallerId}

All properties are required strings used to uniquely identify and query the specific call quality report.

Output

The node outputs JSON data containing the call quality report details corresponding to the provided identifiers. This typically includes metrics such as:

  • Call duration
  • Packet loss rates
  • Jitter values
  • Latency measurements
  • Codec information
  • Other relevant call quality indicators

No binary data output is indicated by the source code or property definitions.

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 uses HTTP requests with JSON responses from the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key and server URL are correctly set up in the node credentials.
  • Incorrect property values: All five identifiers must be provided accurately; otherwise, the API may return errors or empty results.
  • Network connectivity issues: Verify that the n8n instance can reach the 3CX server URL.
  • API response errors: Check for rate limits or permission issues on the 3CX side if calls fail repeatedly.

Common error messages might include authentication failures or "not found" errors if the call identifiers do not match any records.

Links and References

Discussion