Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Actions76

Bridges → Play

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage call bridges. Specifically, the 'Play' operation allows users to play media on a specified bridge. This is useful in scenarios where you want to play announcements, hold music, or any audio media to all participants in a bridge during a call.

Use Case Examples

  1. Playing a welcome message to all participants in a conference call bridge.
  2. Playing hold music while participants wait in a bridge.

Properties

Name Meaning
Bridge ID The unique identifier of the bridge on which the media will be played.
Media URI The URI of the media to be played on the bridge, e.g., a sound file or stream.
Language Optional language code for the media playback, allowing localization.
Playback ID Optional custom identifier for the playback instance, useful for tracking or controlling the playback.

Output

JSON

  • playbackId - The identifier of the playback instance created when media is played on the bridge.
  • bridgeId - The unique identifier of the bridge where the media was played.
  • media - The media URI that was played on the bridge.

Dependencies

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

Troubleshooting

  • Ensure the Bridge ID is correct and the bridge exists in the Asterisk system; otherwise, the play operation will fail.
  • Verify the Media URI is valid and accessible by the Asterisk server to avoid playback errors.
  • If a Playback ID is provided, ensure it is unique to prevent conflicts.
  • Check network connectivity and API credentials if the node cannot connect to the Asterisk ARI endpoint.

Links

Discussion