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

Get voice mail preferences.
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.

Authorization token required true
Admin Authorization token required false

GetVoiceMailPrefsRequest

    <GetVoiceMailPrefsRequest> ## GetVoiceMailPrefsRequest
        <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>
    </GetVoiceMailPrefsRequest>

The following table describes elements and attributes you can define within a <GetVoiceMailPrefsRequest> 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 1) 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

GetVoiceMailPrefsResponse

    <GetVoiceMailPrefsResponse> ## GetVoiceMailPrefsResponse
        <phone [name="{name}"]> ## PhoneInfo
            (<pref [name="{name}"]>{value}</pref> ## PrefInfo)*
         </phone>
    </GetVoiceMailPrefsResponse>

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

XPath Required / Optional Description
/phone Optional (0 or 1) Phone information
/phone@name Optional (0 or 1) Type:String
Name
/phone/pref Optional (0 or more) Type:{value}
Preference information
Description for element text content:Preference value
/phone/pref@name Optional (0 or 1) Type:String
Name