3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node enables creating scheduled reports within the 3CX telephony system. It is designed to automate report generation and distribution by scheduling reports of various types (e.g., call logs, chat logs, queue statistics) to be sent via email at specified intervals. This functionality is useful for administrators or managers who need regular insights into telephony usage, performance metrics, or user activity without manual intervention.

Practical examples include:

  • Automatically receiving daily call log summaries.
  • Scheduling weekly audit logs for compliance review.
  • Generating monthly queue performance reports to optimize staffing.

Properties

Name Meaning
DN The directory number or extension identifier related to the report.
Email Addresses Comma-separated list of email addresses to which the scheduled report will be sent.
Filter Description A textual description of any filters applied to the report data.
Id Numeric identifier for the scheduled report entry.
Name The name assigned to the scheduled report for identification.
Report Link URL or path link to access the generated report.
Report Params Additional parameters or options that customize the report content or format.
Report Type The type of report to generate. Options include: None, Call Logs, Chat Logs, Audit Logs, Inbound Rules, Queue Abandoned Calls, Queue Answered Calls By Waiting Time, Queue Callbacks, Queue Failed Callbacks, Queue Performance Overview, Queue Detailed Statistics, Queue Team General Statistics, Sla Statistics, Sla Breaches, Agent In Queue Statistics, Agent Login History, Extensions Statistics By Ring Groups, Extension Statistics, Call Cost By Extension Dept, Queue Chat Performance, Queue Agents Chat, Abandoned Chats, Ring Groups, Inbound Calls, Out Bound Calls, User Activity, Call Distribution.
Schedule Type Frequency of report generation. Options are Daily, Weekly, Monthly, Hourly, Not Scheduled.

Output

The node outputs JSON data representing the created scheduled report object as returned by the 3CX API. This typically includes confirmation details such as the report ID, name, schedule, recipients, and other metadata confirming successful creation.

If the node supports binary output (not indicated in the provided code), it would likely represent the actual report file or attachment, but this is not evident here.

Dependencies

  • Requires an active connection to a 3CX telephony system API endpoint.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL for the 3CX server must be set correctly in the credentials.
  • The node uses HTTP requests with JSON payloads to interact with the 3CX API.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials can cause authentication failures.
    • Incorrect base URL configuration may lead to connection errors.
    • Providing invalid report types or schedule types might result in API validation errors.
    • Missing required properties like email addresses or report name could cause request rejection.

  • Error messages:

    • Authentication errors: Check API key or OAuth2 token validity and permissions.
    • 404 or connection refused: Verify the 3CX server URL and network accessibility.
    • Validation errors from API: Ensure all required fields are correctly filled and use valid option values.

Links and References

Discussion