Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage call bridges. Specifically, the 'Start Music on Hold' operation allows users to start playing music on hold (MOH) on a specified bridge. This is useful in telephony scenarios where callers need to be placed on hold with music or announcements while waiting.

Use Case Examples

1. In a call center setup, when a caller is placed on hold, this node can start music on hold on the bridge connecting the caller.
2. During a conference call, if a participant is muted or put on hold, this node can be used to play music to that participant.

Properties

Output

JSON

• bridgeId - The unique ID of the bridge where music on hold was started.
• mohClass - The music on hold class used for the operation.
• status - The status or result of the start music on hold operation.

Dependencies

• Requires an API key credential for Asterisk ARI authentication and access.

Troubleshooting

• Ensure the Bridge ID is correct and the bridge exists in the Asterisk system; otherwise, the operation will fail.
• Verify that the MOH class specified is configured in the Asterisk system; an invalid MOH class may cause the music on hold to not start.
• Check network connectivity and API credentials if the node cannot connect to the Asterisk ARI endpoint.

Links

• Asterisk ARI Bridge REST API - Official documentation for managing bridges in Asterisk via ARI, including starting music on hold.