3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list custom prompts configured in the system. It is useful for scenarios where users want to retrieve and manage audio prompts or messages used within their telephony setup, such as greetings, voicemail messages, or menu options.

A practical example would be automating the retrieval of all custom prompts to display them in a dashboard or to synchronize them with another system.

Properties

Name Meaning
Options A collection of query parameters to control the listing of custom prompts:
- 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; supports phrase searching with quotes automatically added if needed.
- Filter ($filter) Filter items by property values using expressions (e.g., State eq 'Connected').
- Count ($count) Include count of 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 allow fine-grained control over the data retrieved from the 3CX system when listing custom prompts.

Output

The node outputs JSON data representing the list of custom prompts retrieved from the 3CX system. Each item in the output typically contains properties of a custom prompt such as its identifier, name, and other metadata depending on the selected fields.

If binary data were involved (e.g., audio files), it would be included in a binary field, but based on the provided code and properties, this node primarily returns JSON metadata about the custom prompts.

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

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed filter or orderby strings) may result in API errors.
    • Network connectivity problems can prevent communication with the 3CX server.

  • Error messages:

    • Authentication errors usually indicate invalid or expired credentials; reconfigure the API key.
    • Query parameter errors often return descriptive messages from the 3CX API; verify syntax and allowed values.
    • Timeout or connection errors suggest network issues or incorrect server URL configuration.

Links and References

Discussion