RTC Client XML Schema

Article
06/30/2006

The Extensible Markup Language (XML) profile provides account information for provisioning a client.

Information on the Session Initiation Protocol (SIP) server, service provider, client data, and session type are all stored in the profile.

The following table shows the attributes for the XML Schema.

Attribute	Description
Client Settings	Client settings configure the client information that is not related to the communications link.
Policy Settings	Policy settings define basic policy information. These settings are supported under the version 1.2 Client API.
Provider Settings	Provider settings define basic information about the provider.
Provision Settings	Provision settings define basic information about the profile to make it unique.
Session Settings	Session settings define basic information about the session.
SIP Server Settings	SIP Server settings specify the available servers.
User Settings	User settings are used for phone-to-phone sessions and define the information required by the third-party server.

The profile uses the following XML schema.

<?xml version="1.0" ?>

<Schema name="ProvisioningSchema.xml" 
        xmlns="urn:schemas-microsoft-com:xml-data" 
        xmlns:dt="urn:schemas-microsoft-com:datatypes">
     <comments>Schema Version MajorRevisionNumber = 1 
                              MinorRevisionNumber = 2
</comments> 

<ElementType name="provision" model="closed">
     <AttributeType name="key" required="yes" /> 
     <attribute type="key" /> 
     <AttributeType name="name" required="yes" /> 
     <attribute type="name" /> 
     <AttributeType name="expires" dt:type="dateTime.tz" /> 
     <attribute type="expires" /> 
     <element type="user" minOccurs="1" maxOccurs="1" /> 
     <element type="sipsrv" minOccurs="1" maxOccurs="*" /> 
     <element type="client" minOccurs="0" maxOccurs="1" /> 
     <element type="provider" minOccurs="0" maxOccurs="1" /> 
     <element type="policy" minOccurs="0" maxOccurs="1">
</ElementType>

<ElementType name="user" model="closed">
     <AttributeType name="uri" required="yes" /> 
     <attribute type="uri" /> 
     <AttributeType name="account" required="no" /> 
     <attribute type="account" /> 
     <AttributeType name="name" required="no" /> 
     <attribute type="name" /> 
     <AttributeType name="password" required="no" /> 
     <attribute type="password"   /> 
     <AttributeType name="realm" required="no" /> 
     <attribute type="realm" />
    <AttributeType name="allowedauth" dt:type="enumeration" dt:values="basic digest negotiate ntlm kerberos allownoauth logoncred" required="no" />
<attribute type="allowedauth" />
</ElementType>

<ElementType name="client" model="closed">
     <AttributeType name="name" required="yes" /> 
     <attribute type="name" /> 
     <AttributeType name="banner" dt:type="bool" required="no" /> 
     <attribute type="banner" /> 
     <AttributeType name="updates" dt:type="bool" required="no" /> 
     <attribute type="updates" /> 
     <AttributeType name="minver" dt:type="fixed.14.4" required="no"/>
     <attribute type="minver" /> 
     <AttributeType name="curver" dt:type="fixed.14.4" required="no"/>
     <attribute type="curver" /> 
     <AttributeType name="updateuri" dt:type="uri" required="no" />
     <attribute type="updateuri" /> 
     <element type="data" minOccurs="0" maxOccurs="1" />
</ElementType>

<ElementType name="data" model="open" /> 

<ElementType name="provider" model="closed" content="mixed">
     <AttributeType name="name" /> 
     <attribute type="name" /> 
     <AttributeType name="homepage" dt:type="uri" required="no" />
     <attribute type="homepage" /> 
     <AttributeType name="helpdesk" dt:type="uri" required="no" />
     <attribute type="helpdesk" /> 
     <AttributeType name="personal" dt:type="uri" required="no" /> 
     <attribute type="personal" /> 
     <AttributeType name="calldisplay" dt:type="uri" required="no" /> 
     <attribute type="calldisplay" /> 
     <AttributeType name="idledisplay" dt:type="uri" required="no" /> 
     <attribute type="idledisplay" /> 
     <element type="data" /> 
</ElementType>
  
<ElementType name="sipsrv" model="closed" content="mixed">
     <AttributeType name="addr" required="yes" /> 
     <attribute type="addr" /> 
     <AttributeType name="protocol" dt:type="enumeration" dt:values="TCP UDP TLS" required="yes" /> 
     <attribute type="protocol" /> 
     <AttributeType name="auth" dt:type="enumeration" dt:values="basic digest" required="no" /> 
     <attribute type="auth" /> 
     <AttributeType name="role" dt:type="enumeration" dt:values="proxy registrar" required="yes" /> 
     <attribute type="role" /> 
     <element type="session" minOccurs="0" maxOccurs="*" /> 
</ElementType>

<ElementType name="session" model="closed">
     <AttributeType name="party" dt:type="enumeration" dt:values="first third" /> 
     <attribute type="party" /> 
     <AttributeType name="type" dt:type="enumeration" dt:values="pc2pc pc2ph ph2ph im" /> 
     <attribute type="type" /> 
</ElementType>

<ElementType name="policy" model="closed">
     <AttributeType name="ftp" dt:type="bool" required="no" />
     <attribute type="ftp"/>
     <AttributeType name="pc2pc" dt:type="bool" required="no" />
     <attribute type="pc2pc"/>
     <AttributeType name="pc2ph" dt:type="bool" required="no" />
     <attribute type="pc2ph"/>
     <AttributeType name="ph2ph" dt:type="bool" required="no" />
     <attribute type="ph2ph"/>
     <AttributeType name="video" dt:type="bool" required="no" />
     <attribute type="video"/>
     <AttributeType name="im" dt:type="bool" required="no" />
     <attribute type="im"/>
     <AttributeType name="datacollab" dt:type="bool" required="no" />
     <attribute type="datacollab"/>
     <AttributeType name="maxbitrate" dt:type="integer" required="no" />
     <attribute type="maxbitrate"/>
</ElementType>

</Schema>

Share via

RTC Client XML Schema

Attributes

See Also

Additional resources