Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage telephony channels. Specifically, the 'Set Variable' operation allows users to set a custom variable on a specified channel, which can be useful for controlling call behavior or storing call-related data dynamically during a call session. Practical examples include setting caller-specific information, flags for call routing, or other metadata that can influence call handling within the PBX.

Use Case Examples

1. Setting a custom variable 'customerType' to 'premium' on a call channel to route the call differently.
2. Storing a session identifier on a channel variable for tracking purposes during a call.

Properties

Output

JSON

• success - Indicates whether the variable was successfully set on the channel.
• channelId - The ID of the channel on which the variable was set.
• variable - The name of the variable that was set.
• value - The value assigned to the variable.

Dependencies

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

Troubleshooting

• Ensure the Channel ID provided is valid and corresponds to an active channel in the Asterisk system.
• Verify that the variable name and value are correctly formatted and supported by the Asterisk system.
• Check API credentials and base URL configuration to ensure proper connection to the ARI endpoint.
• Common error messages may include authentication failures, invalid channel ID, or permission issues when setting variables. Resolving these typically involves verifying credentials, channel existence, and user permissions.

Links

• Asterisk ARI Channels REST API - Official documentation for managing channels and channel variables via ARI.