Asterisk icon

Asterisk

Interact with Asterisk PBX via ARI (Asterisk REST Interface)

Mailboxes → Delete

AI-generated

Overview

This node interacts with the Asterisk PBX system via the Asterisk REST Interface (ARI) to manage voicemail mailboxes. Specifically, the 'Delete' operation under the 'Mailboxes' resource allows users to delete a specified mailbox by its name. This is useful in scenarios where voicemail mailboxes need to be removed, such as when a user leaves an organization or a mailbox is no longer needed.

Use Case Examples

  1. Deleting a mailbox named '1000@default' to free up resources or remove access for a former employee.
  2. Automating mailbox cleanup in a telephony system by deleting mailboxes that are no longer active.

Properties

Name Meaning
Mailbox Name The name of the mailbox to be deleted, required for the delete operation on mailboxes.

Output

JSON

  • success - Indicates whether the mailbox deletion was successful.
  • message - Provides additional information or confirmation about the deletion operation.

Dependencies

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

Troubleshooting

  • Ensure the mailbox name is correctly specified and exists in the Asterisk system; otherwise, the deletion will fail.
  • Verify that the API credentials have sufficient permissions to delete mailboxes.
  • Common error messages may include authentication failures or 'mailbox not found' errors, which can be resolved by checking credentials and mailbox names respectively.

Links

Discussion