Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Applications → Unsubscribe

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, for the 'Applications' resource and 'Unsubscribe' operation, it allows users to unsubscribe from events related to a specified Stasis application and event source. This is useful in scenarios where an automation workflow needs to stop receiving event notifications from a particular application or event source in Asterisk, such as channels, bridges, or device states.

Use Case Examples

  1. Unsubscribing from events of a specific Stasis application to stop receiving call or device state updates.
  2. Managing event subscriptions dynamically in a call center environment to optimize resource usage.

Properties

Name Meaning
Application Name The name of the Stasis application to unsubscribe from events.
Event Source The URI of the event source to unsubscribe from, e.g., channel:id, bridge:id, endpoint:tech/resource, or deviceState:device.

Output

JSON

  • success - Indicates whether the unsubscribe operation was successful.
  • message - Additional information or status message about the unsubscribe operation.

Dependencies

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

Troubleshooting

  • Ensure the 'Application Name' and 'Event Source' are correctly specified and exist in the Asterisk system.
  • Check that the API credentials have sufficient permissions to manage event subscriptions.
  • Common errors include authentication failures, invalid event source URIs, or attempting to unsubscribe from an application or event source that is not currently subscribed.

Links

Discussion