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

Get Voice Folders

Authorization token required true
Admin Authorization token required false

GetVoiceFolderRequest

    <GetVoiceFolderRequest> ## GetVoiceFolderRequest
        <storeprincipal [id="{id-of-user-in-the-backing-store}"] [name="{name-of-user-in-the-backing-store}"]
                            [accountNumber="{account-number}"] /> ## StorePrincipalSpec
        (<phone [name="{name}"]> ## PhoneSpec
            (<pref [name="{name}"] /> ## PrefSpec)*
          </phone>)*
    </GetVoiceFolderRequest>

The following table describes elements and attributes you can define within a <GetVoiceFolderRequest> 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
/phone Optional (0 or more) Phone specification
/phone@name Optional (0 or 1) Type:String
Name
/phone/pref Optional (0 or more) Preferences specification
If no <pref> elements are provided, all known prefs for the requested phone are returned in the response. If <pref> elements are provided, only those prefs are returned in the response.
/phone/pref@name Optional (0 or 1) Type:String
Name

GetVoiceFolderResponse

    <GetVoiceFolderResponse> ## GetVoiceFolderResponse
        (<phone name="{phone-number}" vm="{phone-has-voice-mail-service} (0|1)"> ## VoiceFolderInfo
            <folder name="{folder-name}" id="{phone-ID}" l="{folder-ID}" [view="{view}"]
                       [u="{num-unread-voice-msgs} (Long)"] [n="{total-num-voice-msgs} (Long)"]> ## RootVoiceFolder
                (<folder name="{folder-name}" id="{phone-ID}" l="{folder-ID}" [view="{view}"]
                             [u="{num-unread-voice-msgs} (Long)"] [n="{total-num-voice-msgs} (Long)"] /> ## VoiceFolder)*
            </folder>
          </phone>)*
    </GetVoiceFolderResponse>

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

XPath Required / Optional Description
/phone Optional (0 or more) Information for phones
/phone@name Required (only 1) Type:String
Phone number
/phone@vm Required (only 1) Type:0|1
Set if phone has voice mail service
/phone/folder Required (only 1) Virtual root folder for the phone
/phone/folder@name Required (only 1) Type:String
Folder name
/phone/folder@id Required (only 1) Type:String
Phone ID
/phone/folder@l Required (only 1) Type:String
Folder ID
/phone/folder@view Optional (0 or 1) Type:String
View
/phone/folder@u Optional (0 or 1) Type:Long
Number of unread voice messages
Only present for Trash and Voicemail Inbox
/phone/folder@n Optional (0 or 1) Type:Long
Total number of voice messages
Only present for Trash and Voicemail Inbox
/phone/folder/folder Optional (0 or more) Folders
/phone/folder/folder@name Required (only 1) Type:String
Folder name
/phone/folder/folder@id Required (only 1) Type:String
Phone ID
/phone/folder/folder@l Required (only 1) Type:String
Folder ID
/phone/folder/folder@view Optional (0 or 1) Type:String
View
/phone/folder/folder@u Optional (0 or 1) Type:Long
Number of unread voice messages
Only present for Trash and Voicemail Inbox
/phone/folder/folder@n Optional (0 or 1) Type:Long
Total number of voice messages
Only present for Trash and Voicemail Inbox