Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to update the state of a specified device. It is useful in telephony systems where managing device states such as 'In Use', 'Busy', or 'On Hold' is necessary for call routing, monitoring, or system automation. For example, it can be used to programmatically set a device to 'Ringing' when an incoming call is detected or mark it as 'Not In Use' when the device is idle.

Use Case Examples

1. Setting a device state to 'Busy' when a call is active to prevent new calls from being routed to it.
2. Marking a device as 'On Hold' during a call hold operation to reflect the current status in the system.

Properties

Output

JSON

• deviceName - The name of the device whose state was updated.
• deviceState - The new state set for the device.
• status - The result status of the update operation.

Dependencies

• Asterisk REST Interface (ARI)

Troubleshooting

• Ensure the Asterisk API credentials are correctly configured and have the necessary permissions to update device states.
• Verify that the device name provided exists in the Asterisk system to avoid errors related to unknown devices.
• Check network connectivity to the Asterisk server to prevent request failures.
• Common error messages may include authentication failures, invalid device names, or unsupported device states. Resolving these typically involves verifying credentials, correcting device names, and using valid state values.

Links

• Asterisk ARI Device States Documentation - Official documentation on managing device states via Asterisk ARI.