Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Asterisk → Get Module

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, the 'Get Module' operation under the 'Asterisk' resource retrieves information about a specified Asterisk module. This is useful for system administrators or developers who need to query the status or details of modules loaded in the Asterisk PBX system, such as 'app_voicemail.so'.

Use Case Examples

  1. Retrieve details of the 'app_voicemail.so' module to check if it is loaded and its current status.
  2. Use the node to monitor or audit modules dynamically loaded in the Asterisk system during runtime.

Properties

Name Meaning
Module Name The name of the Asterisk module to retrieve information about, e.g., 'app_voicemail.so'.

Output

JSON

  • module - Details of the requested Asterisk module, including its status and configuration.

Dependencies

  • Requires an API key credential for Asterisk REST Interface (ARI) authentication.

Troubleshooting

  • Ensure the 'Module Name' is correctly spelled and corresponds to an existing module in the Asterisk system.
  • Verify that the Asterisk REST Interface (ARI) is properly configured and accessible at the base URL provided in credentials.
  • Common errors may include authentication failures if the API key or credentials are incorrect, or 404 errors if the specified module does not exist.

Links

Discussion