Personal tools

switchvox.users.voicemail.remove

From SwitchvoxExtendAPI

Jump to: navigation, search

Contents

Description

Removes one or more voicemail/fax message(s) from a folder.

Arguments

See the Constructing Requests page to learn how to use arguments in requests.
Name Required Type Default Description
account_id required The account ID of the extension.
message_ids required An array of message IDs. At least 1 ID is required.
folder required The name of the voicemail/fax folder the message exists in.

Example Requests & Responses

Please see the API Request and Response Format section for more information on various request encodings.

Example One

Request

<?xml version="1.0"?>
<request method="switchvox.users.voicemail.remove">
    <parameters>
        <account_id>1101</account_id>
        <message_ids>
            <message_id>1</message_id>
            <message_id>2</message_id>
        </message_ids>
        <folder>INBOX</folder>
    </parameters>
</request>

Response

<response method="switchvox.users.voicemail.remove">
  <result>
    <success/>
  </result>
</response>

Error Codes

See the Error Code Formatting section to see the xml structure when an error is returned.
See the Generic Error Codes section to see a list of general fault codes that may be returned.
Code Description
66939 Missing the account_id parameter.
10014 Invalid account_id (%1). Account_ids may only contain digits.
84711 That account_id is invalid.
64125 Invalid Folder (%1)
64127 Please provide at least one message ID
64128 Invalid message ID (%1)
27168 Your account is not permitted to run this action.
Retrieved from "http://developers.digium.com/switchvox/wiki/index.php/Switchvox.users.voicemail.remove"