Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to control media playbacks. Specifically, the 'Playbacks' resource with the 'Control' operation allows users to manage playback actions such as restarting, pausing, unpausing, reversing, and forwarding a playback session identified by a unique Playback ID. This is useful in scenarios where automated or manual control over audio playback in telephony applications is required, such as managing hold music, announcements, or recorded messages.

Use Case Examples

1. Restarting a playback from the beginning when a call is transferred.
2. Pausing and unpausing playback during a call based on user input.
3. Fast-forwarding or rewinding a playback to specific points during a call.

Properties

Output

JSON

• success - Indicates whether the control operation was successfully executed.
• playbackId - The ID of the playback that was controlled.
• operation - The control operation performed on the playback.

Dependencies

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

Troubleshooting

• Ensure the Playback ID provided is valid and corresponds to an active playback session in Asterisk.
• Verify that the API credentials are correct and have sufficient permissions to control playbacks.
• Common errors include 'Playback not found' if the Playback ID is incorrect, or 'Unauthorized' if authentication fails. Check the base URL and credentials configuration.
• Network connectivity issues between n8n and the Asterisk server can cause request failures; verify network access and firewall settings.

Links

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