Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Actions76

Channels → Play

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage and control telephony channels. Specifically, the 'Channels - Play' operation allows users to play media files or streams on a specified channel. This is useful in scenarios such as playing announcements, prompts, or recorded messages during a call.

Use Case Examples

  1. Playing a welcome message to a caller by specifying the channel ID and a media URI like 'sound:hello-world'.
  2. Playing a recorded message stored in the system on a specific call channel.

Properties

Name Meaning
Channel ID The unique identifier of the channel on which the media will be played.
Media URI The URI of the media to be played on the channel, such as a sound file or a recording.
Language Optional language code for the media playback, e.g., 'en' for English.
Offset MS Milliseconds to skip before starting the media playback.
Skip MS Milliseconds to skip forward or backward during playback operations.
Playback ID A custom identifier for the playback session, useful for tracking or controlling the playback.

Output

JSON

  • channelId - The ID of the channel on which the media was played.
  • media - The URI of the media that was played.
  • playbackId - The identifier of the playback session, if specified.
  • status - The status or result of the play operation.

Dependencies

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

Troubleshooting

  • Ensure the Channel ID is correct and the channel is active; otherwise, the play operation will fail.
  • Verify the Media URI is valid and accessible by the Asterisk server.
  • Check network connectivity and API credentials if the node cannot communicate with the Asterisk server.
  • Common error messages include 'Channel not found' or 'Media not found', which indicate incorrect input parameters or resource availability issues.

Links

Discussion