3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Play Prompt" operation within the "Prompt Sets" resource of this 3CX node allows users to play a specific prompt to a designated extension number in the 3CX telephony system. This is useful in scenarios where automated voice messages or alerts need to be played to particular extensions, such as notifying employees about meetings, system statuses, or other important announcements.

Practical examples include:

  • Playing a custom recorded message to an employee's phone extension.
  • Broadcasting urgent alerts to selected extensions.
  • Testing prompt playback functionality on specific devices.

Properties

Name Meaning
Id The unique identifier of the prompt set entity to be played. Can be dynamically set via expressions (e.g., {{$json.Id}}).
Extension The target extension number (e.g., 101, 102, 999) where the prompt will be played.
Prompt Id The identifier of the specific prompt within the prompt set to play.

Output

The node outputs JSON data representing the response from the 3CX API after attempting to play the prompt. This typically includes status information about the request, such as success confirmation or error details.

There is no indication that the node outputs binary data.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials for secure access.
  • The base URL for the 3CX server must be provided in the node credentials configuration.

Troubleshooting

  • Common Issues:

    • Invalid or missing prompt set Id or prompt Id can cause the operation to fail.
    • Incorrect extension numbers may result in prompts not being played.
    • Network connectivity issues with the 3CX server can prevent successful requests.

  • Error Messages:

    • Authentication errors indicate problems with the provided API credentials; verify and update them as needed.
    • "Entity not found" errors suggest invalid Ids; double-check the prompt set and prompt identifiers.
    • Timeout or connection errors require checking network access to the 3CX server.

Links and References

Discussion