Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Bridges → Stop Music on Hold

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage call bridges, specifically to stop music on hold for a given bridge. It is useful in telephony systems where controlling call bridges and their media playback is necessary, such as stopping music on hold when a call is ready to be connected or resumed.

Use Case Examples

  1. In a call center setup, stopping music on hold when an agent is ready to take a call.
  2. In an automated call handling system, stopping music on hold when a call is transferred to a live operator.

Properties

Name Meaning
Bridge ID The unique identifier of the bridge on which to stop music on hold.

Output

JSON

  • bridgeId - The unique ID of the bridge for which music on hold was stopped.
  • status - The status or confirmation that music on hold has been stopped on the specified bridge.

Dependencies

  • Requires an API key credential for Asterisk REST Interface (ARI) authentication.

Troubleshooting

  • Ensure the Bridge ID provided is correct and corresponds to an active bridge in the Asterisk system.
  • Verify that the API credentials are valid and have sufficient permissions to control bridges.
  • Common error: 'Bridge not found' - indicates the specified bridge ID does not exist or is not active.
  • Common error: 'Unauthorized' - indicates invalid or missing API credentials.

Links

  • Asterisk ARI Bridges API - Official documentation for managing bridges in Asterisk via ARI, including stopping music on hold.

Discussion