3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing users to retrieve details of a scheduled report by its unique identifier. This operation is useful in scenarios where automated workflows need to fetch and process scheduled report data from 3CX, such as integrating call analytics or monitoring reports into other systems.

For example, a user might set up an automation that triggers when a new scheduled report is created or updated in 3CX, then retrieves the full report details for further processing or notification purposes.

Properties

Name Meaning
Id The unique identifier of the scheduled report to retrieve. Can be set dynamically via expressions.
Options Additional query options:
- Select: Specify which properties of the scheduled report to return (e.g., "Id,Name").
- Expand: Expand related entities to include additional linked data (e.g., "RelatedEntity1,RelatedEntity2").

Output

The node outputs JSON data representing the scheduled report entity retrieved from the 3CX system. The structure of this JSON depends on the selected properties and any expanded related entities specified in the options.

If binary data were involved (e.g., report files), it would be included in the binary output field, but based on the provided code and properties, the output is purely JSON data describing the scheduled report.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing Id: Ensure the "Id" property is correctly set and corresponds to an existing scheduled report in 3CX.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network issues: Confirm that the 3CX server URL is reachable and correctly configured.
  • Incorrect $select or $expand values: Use valid property names and related entity names as per 3CX API documentation to avoid errors or empty responses.

Links and References

Discussion