3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing an operation to list "Prompt Sets." This operation retrieves a collection of prompt sets from the 3CX API, which are typically used for managing audio prompts in call flows or IVR menus. It is useful when you want to programmatically access and manage these prompt sets, for example, to display them in a UI, synchronize with other systems, or automate updates.

Common scenarios include:

  • Fetching available prompt sets to allow users to select one for a call flow.
  • Automating the auditing or reporting of prompt sets.
  • Integrating 3CX prompt sets with external content management or telephony systems.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of prompt sets:
- Top ($top) Show only the first n items (limit results).
- Skip ($skip) Skip the first n items (offset results).
- Search ($search) Search items 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 count of total items in the response (boolean).
- Orderby ($orderby) Order items by 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).

These options correspond to standard OData query parameters, allowing flexible querying of the prompt sets.

Output

The node outputs JSON data representing the list of prompt sets retrieved from the 3CX API. The structure typically includes an array of prompt set objects, each containing properties such as identifiers, names, states, and any selected or expanded fields based on the input options.

If the $count option is enabled, the output will also include the total count of matching prompt sets.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to a 3CX telephony system via its API.
  • Requires an API authentication token credential configured in n8n (an OAuth2-based credential).
  • The base URL for the 3CX API must be provided in the credentials configuration.
  • The node sends HTTP requests with JSON headers and expects JSON responses.

Troubleshooting

  • Authentication errors: Ensure that the API authentication token is valid and has sufficient permissions to read prompt sets.
  • Invalid query parameters: Incorrectly formatted OData queries in options like $filter, $orderby, or $search may cause API errors. Validate the syntax according to 3CX API documentation.
  • Empty results: If no prompt sets are returned, verify that the 3CX system actually contains prompt sets and that filters/search terms are correct.
  • Network issues: Confirm that the server URL is reachable and correctly configured without trailing slashes.

Links and References

Discussion