3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation updates an existing scheduled report in the 3CX telephony system. It allows users to modify various attributes of a scheduled report such as its name, type, schedule frequency, email recipients, and filtering criteria. This is useful for automating report management workflows where reports need to be adjusted dynamically based on changing requirements or user inputs.

Practical examples include:

  • Changing the recipients of a daily call log report.
  • Updating the schedule from weekly to monthly for audit logs.
  • Modifying the filter description or parameters of a queue performance overview report.

Properties

Name Meaning
Id The unique identifier of the scheduled report to update. Can be set via expression like {{$json.Id}}.
DN The directory number associated with the report.
Email Addresses Comma-separated list of email addresses to send the report to.
Filter Description Text description of the filter applied to the report data.
Name The display name of the scheduled report.
Report Link URL link to the report resource.
Report Params Parameters used to generate the report, typically in string format.
Report Type The type/category of the report. 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 at which the report is scheduled to run. Options: Daily, Weekly, Monthly, Hourly, Not Scheduled.

Output

The node outputs JSON data representing the updated scheduled report entity after the update operation completes. The output includes all relevant fields reflecting the new state of the scheduled report.

If the node supports binary data output (not indicated here), it would typically represent downloadable report files or attachments, but this operation focuses on updating metadata rather than returning report content.

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 to the 3CX API endpoint /xapi/v1 to perform the update.

Troubleshooting

  • Invalid Id: If the provided Id does not correspond to an existing scheduled report, the API will likely return an error indicating the entity was not found. Verify the Id value before running.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to update scheduled reports.
  • Invalid property values: Some properties like Report Type and Schedule Type have restricted options. Providing unsupported values may cause validation errors.
  • Network issues: Connectivity problems to the 3CX server will prevent the update from succeeding.
  • Empty required fields: The Id field is mandatory; omitting it will cause the operation to fail.

Links and References

Discussion