3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation "List Prompts" under the "Prompt Sets" resource is designed to retrieve a list of prompts associated with a specific prompt set entity in the 3CX telephony system. It allows users to query and filter prompts by various criteria, making it useful for managing or auditing voice prompts configured in 3CX.

Common scenarios include:

  • Fetching all prompts belonging to a particular prompt set to display or process them.
  • Searching prompts by keywords or filtering based on properties such as state or creation date.
  • Paginating through large sets of prompts using skip and top options.
  • Selecting specific fields or expanding related entities for detailed information.

Practical example:

  • A user wants to get the first 10 prompts from a prompt set with ID 123, filtering only active prompts and ordering them by name descending.

Properties

Name Meaning
Id The unique identifier of the prompt set entity whose prompts are to be listed.
Options Collection of optional query parameters to refine the list:
- Top ($top) Limits the number of items returned to the first n items.
- Skip ($skip) Skips the first n items, useful for pagination.
- Search ($search) Searches prompts by phrases; supports quoted phrases for exact matches.
- Filter ($filter) Filters prompts by property values, e.g., State eq 'Connected'.
- Count ($count) Boolean flag to include the count of total items matching the query.
- Orderby ($orderby) Orders the results by specified property values, e.g., Name desc, CreatedAt asc.
- Select ($select) Selects which properties of the prompts to return, e.g., Id,Name.
- Expand ($expand) Expands related entities to include additional linked data, e.g., RelatedEntity1.

Output

The output JSON contains an array of prompt objects corresponding to the queried prompt set. Each prompt object includes properties as requested via the $select option or defaults to all available properties. If $count is true, the output also includes the total count of matching prompts.

If binary data is present (not indicated explicitly here), it would typically represent audio files or media associated with prompts, but this operation focuses on listing metadata rather than retrieving binary 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 with JSON responses to interact with the 3CX API.

Troubleshooting

  • Missing or invalid Id: The Id property is required. Omitting it or providing an invalid ID will cause errors or empty results.
  • Invalid query options: Incorrect syntax in $filter, $orderby, or other OData-like query parameters may result in API errors.
  • Authentication failures: Ensure the API key credential is valid and has sufficient permissions.
  • Network issues: Connectivity problems to the 3CX server will prevent data retrieval.
  • Empty results: Could indicate no prompts match the criteria or incorrect prompt set ID.

Links and References

Discussion