Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Asterisk → Get Config Object

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, the 'Get Config Object' operation retrieves a dynamic configuration object from a specified configuration class within Asterisk. This is useful for scenarios where you need to programmatically access and manage Asterisk configuration data, such as fetching endpoint configurations or other system settings.

Use Case Examples

  1. Retrieve the configuration details of a SIP endpoint by specifying the 'res_pjsip' configuration class, 'endpoint' object type, and the unique identifier of the endpoint.
  2. Fetch a specific configuration object from a custom configuration class to inspect or use its properties in an automation workflow.

Properties

Name Meaning
Configuration Class The configuration class containing dynamic configuration objects to query.
Object Type The type of configuration object to retrieve within the specified configuration class.
Object ID The unique identifier of the configuration object to fetch.

Output

JSON

  • data - The retrieved configuration object data from Asterisk.

Dependencies

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

Troubleshooting

  • Ensure the base URL and credentials for the Asterisk API are correctly configured to avoid authentication errors.
  • Verify that the specified configuration class, object type, and object ID exist in the Asterisk system to prevent 'not found' errors.
  • Check network connectivity to the Asterisk server to avoid request timeouts or connection failures.

Links

Discussion