Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, the 'Delete Config Object' operation allows users to delete a dynamic configuration object within a specified configuration class in Asterisk. This is useful for managing and cleaning up configuration objects such as endpoints or other dynamic entities in the PBX system.

Use Case Examples

1. Deleting a SIP endpoint configuration object from the 'res_pjsip' configuration class by specifying its unique ID.
2. Removing a custom configuration object from a specific class to update the PBX setup dynamically without manual file edits.

Properties

Output

JSON

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

Dependencies

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

Troubleshooting

• Ensure the API credentials are correct and have sufficient permissions to delete configuration objects.
• Verify that the specified configuration class, object type, and object ID exist in the Asterisk system; otherwise, the deletion will fail.
• Common error messages may include 'Not Found' if the object does not exist, or 'Unauthorized' if the API credentials lack proper permissions. Check the credentials and object identifiers to resolve these issues.

Links

• Asterisk REST Interface (ARI) Documentation - Official documentation for interacting with Asterisk via ARI, including configuration object management.