Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Channels → Unhold

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage telephony channels. Specifically, the 'Unhold' operation for the 'Channels' resource allows users to take a channel off hold, resuming the call. This is useful in call center or telephony applications where calls may be placed on hold and later resumed.

Use Case Examples

  1. In a call center workflow, after placing a caller on hold to consult with a supervisor, the agent can use this node to unhold the channel and resume the conversation.
  2. In an automated telephony system, the node can be used to programmatically unhold a call after a certain event or condition is met.

Properties

Name Meaning
Channel ID The unique identifier of the channel to be unheld. This is required to specify which call channel should be taken off hold.

Output

JSON

  • success - Indicates whether the unhold operation was successful.
  • data - Contains details about the channel after the unhold operation, such as its current state and metadata.

Dependencies

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

Troubleshooting

  • If the Channel ID is incorrect or does not exist, the node will fail to unhold the channel. Verify the Channel ID before running the node.
  • Network or authentication issues with the Asterisk ARI endpoint can cause failures. Ensure the base URL and credentials are correctly configured.
  • If the channel is not currently on hold, the unhold operation may not have any effect or may return an error.

Links

Discussion