3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get Prompt Set" operation in the Prompt Sets resource retrieves a specific prompt set entity by its unique identifier. This node is useful when you need to fetch detailed information about a particular prompt set from the 3CX telephony system, such as for configuration, reporting, or integration purposes.

Practical examples include:

  • Fetching a prompt set's details to display or modify in an external application.
  • Using the retrieved prompt set data to automate telephony workflows.
  • Integrating prompt set information into customer support dashboards.

Properties

Name Meaning
Id The unique numeric identifier of the prompt set to retrieve. Supports expressions like {{$json.Id}}.
Options Additional query options to customize the returned data:
- Select ($select) Comma-separated list of properties to return (e.g., Id,Name).
- Expand ($expand) Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the requested prompt set entity. The structure includes the properties selected via the $select option and any related entities expanded via the $expand option. The output contains all relevant fields of the prompt set, such as its ID, name, and potentially nested related data depending on the query options.

No binary data output is indicated.

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

Troubleshooting

  • Common issues:

    • Invalid or missing prompt set ID will result in errors or empty responses.
    • Incorrect API credentials or server URL misconfiguration can cause authentication failures.
    • Improper use of $select or $expand options may lead to unexpected or incomplete data.

  • Error messages:

    • Authentication errors typically indicate invalid or missing API credentials.
    • Not found errors suggest the specified prompt set ID does not exist.
    • Malformed query parameter errors occur if $select or $expand values are incorrectly formatted.

  • Resolutions:

    • Verify the prompt set ID exists and is correctly passed.
    • Ensure API credentials and server URL are properly configured.
    • Use valid property names in $select and valid related entity names in $expand.

Links and References

Discussion