3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to list scheduled reports. This operation is useful for retrieving a collection of scheduled report entries from the 3CX system, allowing users to query and manage telephony reports programmatically within their workflows.

Common scenarios include:

  • Automating the retrieval of scheduled telephony reports for analysis or archival.
  • Filtering and searching scheduled reports based on specific criteria.
  • Paginating through large sets of scheduled reports.
  • Selecting specific fields or expanding related entities in the returned data.

Practical example:
A user wants to fetch the top 10 scheduled reports that are currently active and order them by creation date descending. They can configure this node to send the appropriate query parameters to the 3CX API and receive the filtered list automatically.

Properties

Name Meaning
Options Collection of optional query parameters to customize the list request:
- Top: Show only the first n items (pagination limit).
- Skip: Skip the first n items (pagination offset).
- Search: Search items by search phrases; supports automatic quoting if phrase contains spaces.
- Filter: Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
- Count: Include count of total items in the response (boolean).
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc).
- Select: Select specific properties to be returned (comma-separated list).
- Expand: Expand related entities to include additional linked data.

Output

The node outputs JSON data representing the list of scheduled reports retrieved from the 3CX API. The structure typically includes an array of scheduled report objects, each containing properties as requested via the $select option or default fields otherwise.

If the $count option is enabled, the output may also include metadata about the total number of items available.

No binary data output is indicated for this operation.

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 HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or other options may cause API errors. Validate OData query expressions carefully.
  • Empty results: If no scheduled reports are returned, verify the filter/search criteria or pagination settings.
  • Network issues: Confirm connectivity to the 3CX server URL and that it is reachable from the n8n environment.

Links and References

Discussion