IP Phone Suite Provisioning
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
Windows Embedded CE 6.0 provides a simple, flexible approach for provisioning. Two provisioning APIs (PHProcessProvisionXML and PHValidateProvisionXML) are exposed through PhCommon.dll. They can be used directly to provision supported VoIP settings or they can be incorporated into custom provisioning applications. For more information, see IP Phone Suite Provisioning API.
To specify the HTTP proxy address and port, use the form address:port. If no port is specified, the default value used will be port 80.
The following table shows the supported provisioning settings:
| Setting | Description | Encrypted | Location |
|---|---|---|---|
SIPSettings |
XML String that complies with RTC API. For more information see SIP Server Settings. |
Yes |
File |
VoicemailSettings |
XML String that complies with RTC API. |
Yes |
File |
VoicemailNumber |
Phone number of voice mail. |
No |
Registry |
BackupSIPSettings |
XML String that complies with RTC API. |
Yes |
File |
DialPlan |
XML string that complies with Dial Plan. For more information, see DialPlan Component. |
No |
File |
If the Dial Plan displays a phone number in a particular form, it must have a rule that recognizes phone numbers of that form and correctly formats the number for dialing. For example, an internal extension might be a five-digit telephone number, so the five-digit number 23456 might be displayed as "Internal extension: 23456". Similarly, the number 4255552345 might be displayed as "External call: (425) 555-2345". The displayed strings would not connect if typed directly into the input field; rather, they are formatted displays.
XML Provisioning Format
A IP Phone Suite provisioning file is an XML file with the following format:
<voip-provision>
<set name=”” value=””/>
<delete name=””/>
<query name=””/>
</voip-provision>
A VoIP Provisioning file consists of one or more of the following elements:
| Element | Description |
|---|---|
<set> |
Assigns a value to a setting. Attributes: Name Value |
<delete> |
Deletes the settings current value. Attributes: name |
<query> |
Gets the settings current value. The value is returned in XML provisioning format. For example: Input XML: Output XML: Attributes: name |
Note
Performing multiple operations on a setting in the same XML document is not allowed. For example:. <voip-provision> <set name=”SIPSettings” value=”XXXX” /> <delete name=”SIPSettings” /> </voip-provision> <voip-provision> <set name=”VoicemeialNumber” value=”4257075695” /> <set name=”VoicemailNumber” value=”4255555555” /> </voip-provision>
Note
An output XML file is only returned if a valid input XML file contains a "query" element. Input XML: <voip-provision> <set name=”SIPSettings” value=”XXXX” /> <query name=”VoicemailSettings” /> </voip-provision> Output XML: <voip-provision> <query name=”VoicemailSettings” value=”4257075695” /> </voip-provision>
Note
If an XML file contains invalid data or incorrect format, then all changes specified in the file will be discarded.
See Also
Concepts
IP Phone Suite
Using the PhCommon Core Component
IP Phone Suite Provisioning API
IP Phone Suite Provisioning Examples