Delete Voicemail Files

Delete voicemail files of a specific extension.

Request URL

{base_url}/{api_path}/voicemail/delete?token={token}

Request parameters

Parameter Required Type Description
number Yes String Extension number, which means which extension's voicemail files will be deleted.

Valid values:

  • An extension number: Delete voicemails of the specified extension.

    Example: "number": "4000"

  • Multiple extension numbers: Delete voicemails of multiple extensions. Separate multiple extension numbers with ,.

    Example: "number": "4000,4001"

  • all: Delete voicemails of all extensions.

    Example: "number":"all"
voicemailfile Yes String Voicemail filename.

Valid values:

  • A voicemail filename: Delete the specified voicemail.

    Example: "voicemailfile": "msg0000.wav"

  • Multiple voicemail filenames: Delete multiple voicemails. Separate multiple voicemail names with ,.

    Example: "voicemailfile": "msg0000.wav, msg0001.wav"

  • all: Delete all voicemails.

    Example: "number":"all"
voicemailstatus Yes String Voicemail status.

Valid values:

  • read
  • unread
  • all: Ignore voicemail status, and delete all voicemails.

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed

Examples

Request example

Delete the unread voicemail file “msg0000.wav” of extension 2023.

POST /api/v2.0.0/voicemail/delete?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "2023",
	"voicemailfile": "msg0000.wav",
	"voicemailstatus": "unread"
}
Response example
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success"
}