Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, the 'Playbacks - Stop' operation allows users to stop a media playback on the Asterisk system by specifying the unique Playback ID. This is useful in scenarios where an ongoing audio playback needs to be halted, such as stopping hold music or announcements during a call.

Use Case Examples

1. Stopping a playback of hold music on a call by providing the Playback ID.
2. Halting an announcement playback in an automated call flow.

Properties

Output

JSON

• playback - Details of the stopped playback returned from the Asterisk system.

Dependencies

• Requires an API key credential for authenticating with the Asterisk REST Interface (ARI).

Troubleshooting

• Ensure the Playback ID provided is correct and corresponds to an active playback; otherwise, the stop operation will fail.
• Verify that the API credentials are valid and have sufficient permissions to control playbacks.
• Common error messages may include 'Playback not found' if the ID is invalid, or authentication errors if credentials are incorrect.

Links

• Asterisk ARI Playbacks Documentation - Official documentation for managing playbacks via Asterisk REST Interface.