Service: zimbraVoice
Namespace: "urn:zimbraVoice"
UploadVoiceMail SOAP Command

Retrieve the voice mail body from the gateway and upload(save) it as an attachment on the server.

Authorization token required true
Admin Authorization token required false

UploadVoiceMailRequest

    <UploadVoiceMailRequest> ## UploadVoiceMailRequest
        <storeprincipal [id="{id-of-user-in-the-backing-store}"] [name="{name-of-user-in-the-backing-store}"]
                            [accountNumber="{account-number}"] /> ## StorePrincipalSpec
        <vm id="{voicemail-id}" phone="{phone-number}" /> ## VoiceMsgUploadSpec
    </UploadVoiceMailRequest>

The following table describes elements and attributes you can define within a <UploadVoiceMailRequest> element:

XPath Required / Optional Description
/storeprincipal Optional (0 or 1) Store Principal specification
/storeprincipal@id Optional (0 or 1) Type:String
ID of user in the backing store
/storeprincipal@name Optional (0 or 1) Type:String
Name of user in the backing store
/storeprincipal@accountNumber Optional (0 or 1) Type:String
Account Number
/vm Optional (0 or 1) Specification of voice message to upload
/vm@id Required (only 1) Type:String
Message id of the voice mail. It can only be a voice mail in the INBOX, not the trash folder.
/vm@phone Required (only 1) Type:String
Phone number of the voice mail

UploadVoiceMailResponse

    <UploadVoiceMailResponse> ## UploadVoiceMailResponse
        <upload id="{upload-id}" /> ## VoiceMsgUploadInfo
    </UploadVoiceMailResponse>

The following table describes elements and attributes you can define within a <UploadVoiceMailResponse> element:

XPath Required / Optional Description
/upload Optional (0 or 1) Upload information
/upload@id Required (only 1) Type:String
Upload id of the upload. It can be used in subsequent mailing requests as the attachment id.