3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing functionality to list call flow scripts. It allows users to retrieve and manage call flow scripts configured in their 3CX environment. This is useful for automating telephony workflows, monitoring call routing logic, or integrating call flow data into other systems.

A practical example would be fetching a filtered list of call flow scripts that match certain criteria (e.g., only active scripts or those created after a specific date) to display in a dashboard or trigger further automation based on the retrieved scripts.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of call flow scripts:
- Top ($top) Show only the first n items returned.
- Skip ($skip) Skip the first n items in the result set.
- Search ($search) Search call flow scripts by search phrases. If the phrase contains spaces and is not quoted, it will be automatically quoted.
- Filter ($filter) Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
- Count ($count) Include the count of total items matching the query. Boolean value.
- Orderby ($orderby) Order items by specified property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Select specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expand related entities to include additional linked data (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the list of call flow scripts retrieved from the 3CX system. The structure typically includes an array of call flow script objects, each containing properties such as identifiers, names, states, creation dates, and any other selected or expanded fields as per the input options.

If binary data were involved (not indicated here), it would represent associated files or media related to call flow scripts, but this node focuses on JSON metadata output.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects the base URL of the 3CX server to be provided in credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.
  • Proper OAuth2 authentication setup is necessary to authorize API calls.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions to access call flow scripts.
  • Empty results: Check if filters, search phrases, or pagination options are too restrictive.
  • Invalid query parameters: Use correct OData syntax for $filter, $orderby, and other options; otherwise, the API may reject the request.
  • Network issues: Verify connectivity to the 3CX server URL and that the server is reachable.
  • Unexpected response format: Confirm the 3CX API version matches the expected /xapi/v1 endpoint and that no breaking changes have occurred.

Links and References

Discussion