Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Channels → Hold

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage telephony channels. Specifically, the 'Hold' operation allows users to place a call channel on hold by specifying the unique Channel ID. This is useful in call center scenarios, automated call handling, or any telephony application where managing call states is necessary.

Use Case Examples

  1. Placing an active call on hold during a customer support session.
  2. Automating call flow by programmatically holding a call while waiting for an agent to become available.

Properties

Name Meaning
Channel ID The unique identifier of the channel to be placed on hold.

Output

JSON

  • channel - Details of the channel that was placed on hold.
  • status - The status or result of the hold operation.

Dependencies

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

Troubleshooting

  • Ensure the Channel ID provided is valid and corresponds to an active channel in the Asterisk system.
  • Check that the API credentials are correct and have sufficient permissions to perform channel operations.
  • Common errors include 'Channel not found' if the Channel ID is incorrect, or 'Permission denied' if the API key lacks necessary rights.

Links

Discussion