Overview | Service | Command |
Get voice information
Authorization token required | true |
Admin Authorization token required | false |
<GetVoiceInfoRequest> ## GetVoiceInfoRequest
(<phone [name="{name}"]> ## PhoneSpec
(<pref [name="{name}"] /> ## PrefSpec)*
</phone>)*
</GetVoiceInfoRequest>
The following table describes elements and attributes you can define within a
<GetVoiceInfoRequest>
element:
XPath | Required / Optional | Description |
/phone | Optional (0 or more) | Phones |
/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 |
<GetVoiceInfoResponse> ## GetVoiceInfoResponse
<audioType>{audioContentType} (String)</audioType>
<storeprincipal [id="{id-of-user-in-the-backing-store}"] [name="{name-of-user-in-the-backing-store}"]
[accountNumber="{account-number}"] /> ## StorePrincipalSpec
(<phone name="{phone-number}" id="{phone-ID}" label="{phone-name/label}" callable="(0|1)" editable="(0|1)"
[type="{phone-type}"] [c2cDeviceId="{click-2-call-device-id}"] vm="{phone-has-voice-mail-service} (0|1)"
[used="{voice-mailbox-quota-used} (Long)"] [limit="{voice-mailbox-quota-limit} (Long)"]> ## VoiceInfo
<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>
<callfeatures>
(<callfeature name="{call-feature}" /> ## CallFeature)*
</callfeatures>
</phone>)*
</GetVoiceInfoResponse>
The following table describes elements and attributes you can define within a
<GetVoiceInfoResponse>
element:
XPath | Required / Optional | Description |
/audioType | Required (only 1) | Type:{audioContentType} (String) default Content-Type of voice mail audio, e.g. audio/wav, audio/mpeg |
/storeprincipal | Required (only 1) | storeprincipal contains principal information of the user in the backing store. For some stores (e.g. the Velodrome store), this principal information is required for subsequent requests. storeprincipal will always be present in the GetVoiceInfoResponse, but the id and name attributes may not always be available. Client should pass all the available store principal information to subsequent voice SOAP requests. |
/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) | Information related to phone numbers.
Note that multiple phone numbers can be associated with the same account. |
/phone@name | Required (only 1) | Type:String Phone number |
/phone@id | Required (only 1) | Type:String Phone ID |
/phone@label | Required (only 1) | Type:String Phone name/label |
/phone@callable | Required (only 1) | Type:0|1 Set if click to call is enabled for the phone number |
/phone@editable | Required (only 1) | Type:0|1 Set if the phone number and label can be edited |
/phone@type | Optional (0 or 1) | Type:String Phone type (Optional). Currently used in Mitel, it denotes the type of phone. Possible values are: DeskPhone, SoftPhone, Voicemail, MobileExt, EDHU, PRG, OTHER |
/phone@c2cDeviceId | Optional (0 or 1) | Type:String click-2-call Device ID |
/phone@vm | Required (only 1) | Type:0|1 Set if phone has voice mail service |
/phone@used | Optional (0 or 1) | Type:Long Voice mailbox quota used in bytes (available only if the phone has voicemail service) |
/phone@limit | Optional (0 or 1) | Type:Long Voice mailbox quota limit in bytes, or 0 if unlimited (available only if the phone has voicemail 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 |
/phone/callfeatures | Required (only 1) | |
/phone/callfeatures/callfeature | Optional (0 or more) | |
/phone/callfeatures/callfeature@name | Required (only 1) | Type:String Call feature name |