Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage telephony channels. Specifically, the 'Delete' operation under the 'Channels' resource allows users to hang up or delete a specific channel (call) by its unique Channel ID. This is useful in scenarios where a call needs to be programmatically terminated, such as ending a call after a certain condition is met or cleaning up stale calls.

Use Case Examples

1. Automatically hang up a call when a customer disconnects.
2. Programmatically terminate a call after a timeout or error condition.

Properties

Output

JSON

• success - Indicates whether the channel was successfully deleted.
• message - Additional information or error message related to the delete operation.

Dependencies

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

Troubleshooting

• Ensure the Channel ID provided is valid and currently active in the Asterisk system; otherwise, the delete operation will fail.
• If the API credentials are incorrect or missing, the node will not be able to connect to the Asterisk ARI and will throw an authentication error.
• The 'Reason' field is optional but if provided, it should be a valid hangup cause recognized by Asterisk to avoid unexpected behavior.

Links

• Asterisk ARI Channels API - Official documentation for managing channels via the Asterisk REST Interface.