3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Delete Custom Prompt" operation in the Custom Prompts resource allows users to delete a specific custom prompt file from the 3CX telephony system. This is useful for managing and cleaning up unused or outdated audio prompts that are no longer needed in the system.

Typical use cases include:

  • Removing obsolete voice prompts after updates.
  • Automating cleanup of custom prompts as part of a deployment or maintenance workflow.
  • Managing storage by deleting large or unnecessary prompt files.

Properties

Name Meaning
Filename The name of the custom prompt file to delete. Supports expressions, e.g., {{$json.Filename}}. This identifies which prompt will be removed.
If Match Optional ETag header value used for concurrency control. Ensures the prompt is deleted only if it matches the specified version.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this would include confirmation of deletion or any error messages returned by the API. There is no binary output associated with this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects the base URL of the 3CX server to be configured in the credentials.
  • The API endpoint used is under /xapi/v1 on the 3CX server.

Troubleshooting

  • Common issues:

    • Providing an incorrect or non-existent filename will result in an error indicating the prompt was not found.
    • Missing or invalid authentication credentials will cause authorization errors.
    • Using an incorrect or stale ETag value in the "If Match" property may lead to a precondition failure, preventing deletion.

  • Error messages:

    • 404 Not Found: The specified prompt filename does not exist.
    • 401 Unauthorized: Authentication failed due to missing or invalid credentials.
    • 412 Precondition Failed: The ETag provided in "If Match" does not match the current version of the prompt.

To resolve these errors:

  • Verify the filename is correct and exists on the server.
  • Ensure valid API credentials are configured.
  • Use the latest ETag value when using the "If Match" header to avoid concurrency conflicts.

Links and References

Discussion