Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI). Specifically, the 'Mailboxes - Get' operation retrieves information about a specified voicemail mailbox within the Asterisk system. This is useful for scenarios where you need to access or manage voicemail mailboxes programmatically, such as fetching mailbox details for monitoring or integration with other communication tools.

Use Case Examples

1. Retrieve details of a specific voicemail mailbox by providing its name, e.g., '1000@default'.
2. Use the mailbox information to integrate voicemail status into a customer support dashboard.

Properties

Output

JSON

• mailbox - Details of the requested mailbox, including its properties and status.

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 the node credentials.

Troubleshooting

• Ensure the mailbox name is correctly specified and exists in the Asterisk system; otherwise, the node may return an error indicating the mailbox was not found.
• Verify that the API credentials and base URL are correctly configured to avoid authentication or connection errors.
• Common error messages include 'Mailbox not found' or 'Authentication failed', which can be resolved by checking mailbox names and credential settings respectively.

Links

• Asterisk ARI Mailboxes Resource - Official documentation for managing mailboxes via the Asterisk REST Interface.