Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Actions76

Asterisk → Update Config Object

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to update configuration objects dynamically. It is useful for managing and modifying Asterisk configuration classes, such as updating endpoints or other configuration objects by specifying their class, type, and unique identifier. For example, it can update the caller ID of a SIP endpoint dynamically without manual configuration file edits.

Use Case Examples

  1. Updating the caller ID of a SIP endpoint in the 'res_pjsip' configuration class by specifying the object type as 'endpoint' and the object ID as '1000', with the new caller ID value provided in the fields JSON.
  2. Modifying voicemail mailbox settings by targeting the appropriate configuration class and object type with updated fields.

Properties

Name Meaning
Configuration Class The configuration class containing dynamic configuration objects to be updated.
Object Type The type of configuration object to update within the specified configuration class.
Object ID The unique identifier of the configuration object to update.
Fields The configuration fields to update, provided as a JSON object or an array of configuration tuples specifying attributes and their new values.

Output

JSON

  • updatedObject - The updated configuration object after the update operation.

Dependencies

  • Requires an API key credential for authenticating with the Asterisk REST Interface (ARI).
  • Needs the base URL of the Asterisk ARI endpoint configured in credentials.

Troubleshooting

  • Ensure the API credentials are correct and have sufficient permissions to update configuration objects.
  • Verify that the configuration class, object type, and object ID exist and are correctly specified to avoid 'not found' errors.
  • Check that the fields JSON is properly formatted and valid to prevent JSON parsing errors or invalid update requests.

Links

Discussion