File: rfc5022.html

package info (click to toggle)
doc-rfc 20230121-1
links: PTS, VCS
area: non-free
in suites: bookworm, forky, sid, trixie
size: 1,609,944 kB
file content (4533 lines) | stat: -rw-r--r-- 221,758 bytes
parent folder | download | duplicates (2)
<pre>Network Working Group                                        J. Van Dyke
Request for Comments: 5022                      Cantata Technology, Inc.
Obsoletes: <a href="./rfc4722">4722</a>                                           E. Burger, Ed.
Category: Informational                                BEA Systems, Inc.
                                                              A. Spitzer
                                                         Bluesocket Inc.
                                                          September 2007


       <span class="h1">Media Server Control Markup Language (MSCML) and Protocol</span>

Status of This Memo

   This memo provides information for the Internet community.  It does
   not specify an Internet standard of any kind.  Distribution of this
   memo is unlimited.

IESG Note

   This RFC is not a candidate for any level of Internet Standard.  The
   IETF disclaims any knowledge of the fitness of this RFC for any
   purpose and in particular notes that the decision to publish is not
   based on IETF review for such things as security, congestion control,
   or inappropriate interaction with deployed protocols.  The RFC Editor
   has chosen to publish this document at its discretion.  Readers of
   this document should exercise caution in evaluating its value for
   implementation and deployment.  See <a href="./rfc3932">RFC 3932</a> for more information.

Abstract

   Media Server Control Markup Language (MSCML) is a markup language
   used in conjunction with SIP to provide advanced conferencing and
   interactive voice response (IVR) functions.  MSCML presents an
   application-level control model, as opposed to device-level control
   models.  One use of this protocol is for communications between a
   conference focus and mixer in the IETF SIP Conferencing Framework.















<span class="grey">Van Dyke, et al.             Informational                      [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


Table of Contents

   <a href="#section-1">1</a>. Introduction ....................................................<a href="#page-4">4</a>
      <a href="#section-1.1">1.1</a>. Conventions Used in This Document ..........................<a href="#page-5">5</a>
   <a href="#section-2">2</a>. MSCML Approach ..................................................<a href="#page-5">5</a>
   <a href="#section-3">3</a>. Use of SIP Request Methods ......................................<a href="#page-6">6</a>
   <a href="#section-4">4</a>. MSCML Design ....................................................<a href="#page-8">8</a>
      <a href="#section-4.1">4.1</a>. Transaction Model ..........................................<a href="#page-8">8</a>
      <a href="#section-4.2">4.2</a>. XML Usage ..................................................<a href="#page-9">9</a>
           <a href="#section-4.2.1">4.2.1</a>. MSCML Time Values ...................................<a href="#page-9">9</a>
   <a href="#section-5">5</a>. Advanced Conferencing ..........................................<a href="#page-10">10</a>
      <a href="#section-5.1">5.1</a>. Conference Model ..........................................<a href="#page-10">10</a>
      <a href="#section-5.2">5.2</a>. Configure Conference Request &lt;configure_conference&gt; .......<a href="#page-11">11</a>
      <a href="#section-5.3">5.3</a>. Configure Leg Request &lt;configure_leg&gt; .....................<a href="#page-13">13</a>
      <a href="#section-5.4">5.4</a>. Terminating a Conference ..................................<a href="#page-14">14</a>
      <a href="#section-5.5">5.5</a>. Conference Manipulation ...................................<a href="#page-15">15</a>
      <a href="#section-5.6">5.6</a>. Video Conferencing ........................................<a href="#page-16">16</a>
      <a href="#section-5.7">5.7</a>. Conference Events .........................................<a href="#page-17">17</a>
      <a href="#section-5.8">5.8</a>. Conferencing with Personalized Mixes ......................<a href="#page-18">18</a>
           5.8.1. MSCML Elements and Attributes for
                  Personalized Mixes .................................<a href="#page-19">19</a>
           <a href="#section-5.8.2">5.8.2</a>. Example Usage of Personalized Mixes ................<a href="#page-20">20</a>
   <a href="#section-6">6</a>. Interactive Voice Response (IVR) ...............................<a href="#page-23">23</a>
      <a href="#section-6.1">6.1</a>. Specifying Prompt Content .................................<a href="#page-24">24</a>
           <a href="#section-6.1.1">6.1.1</a>. Use of the Prompt Element ..........................<a href="#page-24">24</a>
      <a href="#section-6.2">6.2</a>. Multimedia Processing for IVR .............................<a href="#page-30">30</a>
      <a href="#section-6.3">6.3</a>. Playing Announcements &lt;play&gt; ..............................<a href="#page-31">31</a>
      <a href="#section-6.4">6.4</a>. Prompt and Collect &lt;playcollect&gt; ..........................<a href="#page-32">32</a>
           <a href="#section-6.4.1">6.4.1</a>. Control of Digit Buffering and Barge-In ............<a href="#page-33">33</a>
           <a href="#section-6.4.2">6.4.2</a>. Mapping DTMF Keys to Special Functions .............<a href="#page-33">33</a>
           <a href="#section-6.4.3">6.4.3</a>. Collection Timers ..................................<a href="#page-35">35</a>
           <a href="#section-6.4.4">6.4.4</a>. Logging Caller DTMF Input ..........................<a href="#page-36">36</a>
           <a href="#section-6.4.5">6.4.5</a>. Specifying DTMF Grammars ...........................<a href="#page-36">36</a>
           <a href="#section-6.4.6">6.4.6</a>. Playcollect Response ...............................<a href="#page-37">37</a>
           <a href="#section-6.4.7">6.4.7</a>. Playcollect Example ................................<a href="#page-38">38</a>
      <a href="#section-6.5">6.5</a>. Prompt and Record &lt;playrecord&gt; ............................<a href="#page-38">38</a>
           <a href="#section-6.5.1">6.5.1</a>. Prompt Phase .......................................<a href="#page-38">38</a>
           <a href="#section-6.5.2">6.5.2</a>. Record Phase .......................................<a href="#page-39">39</a>
           <a href="#section-6.5.3">6.5.3</a>. Playrecord Example .................................<a href="#page-41">41</a>
      <a href="#section-6.6">6.6</a>. Stop Request &lt;stop&gt; .......................................<a href="#page-42">42</a>
   <a href="#section-7">7</a>. Call Leg Events ................................................<a href="#page-43">43</a>
      <a href="#section-7.1">7.1</a>. Keypress Events ...........................................<a href="#page-43">43</a>
           <a href="#section-7.1.1">7.1.1</a>. Keypress Subscription Examples .....................<a href="#page-45">45</a>
           <a href="#section-7.1.2">7.1.2</a>. Keypress Notification Examples .....................<a href="#page-45">45</a>
      <a href="#section-7.2">7.2</a>. Signal Events .............................................<a href="#page-46">46</a>
           <a href="#section-7.2.1">7.2.1</a>. Signal Event Examples ..............................<a href="#page-47">47</a>
   <a href="#section-8">8</a>. Managing Content &lt;managecontent&gt; ...............................<a href="#page-48">48</a>
      <a href="#section-8.1">8.1</a>. Managecontent Example .....................................<a href="#page-50">50</a>



<span class="grey">Van Dyke, et al.             Informational                      [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   <a href="#section-9">9</a>. Fax Processing .................................................<a href="#page-51">51</a>
      <a href="#section-9.1">9.1</a>. Recording a Fax &lt;faxrecord&gt; ...............................<a href="#page-51">51</a>
      <a href="#section-9.2">9.2</a>. Sending a Fax &lt;faxplay&gt; ...................................<a href="#page-53">53</a>
   <a href="#section-10">10</a>. MSCML Response Attributes and Elements ........................<a href="#page-56">56</a>
      <a href="#section-10.1">10.1</a>. Mechanism ................................................<a href="#page-56">56</a>
      <a href="#section-10.2">10.2</a>. Base &lt;response&gt; Attributes ...............................<a href="#page-56">56</a>
      <a href="#section-10.3">10.3</a>. Response Attributes and Elements for &lt;configure_leg&gt; .....<a href="#page-57">57</a>
      <a href="#section-10.4">10.4</a>. Response Attributes and Elements for &lt;play&gt; ..............<a href="#page-57">57</a>
            <a href="#section-10.4.1">10.4.1</a>. Reporting Content Retrieval Errors ...............<a href="#page-58">58</a>
      <a href="#section-10.5">10.5</a>. Response Attributes and Elements for &lt;playcollect&gt; .......<a href="#page-59">59</a>
      <a href="#section-10.6">10.6</a>. Response Attributes and Elements for &lt;playrecord&gt; ........<a href="#page-60">60</a>
      <a href="#section-10.7">10.7</a>. Response Attributes and Elements for &lt;managecontent&gt; .....<a href="#page-61">61</a>
      10.8. Response Attributes and Elements for &lt;faxplay&gt;
            and &lt;faxrecord&gt; ..........................................<a href="#page-61">61</a>
   <a href="#section-11">11</a>. Formal Syntax .................................................<a href="#page-62">62</a>
      <a href="#section-11.1">11.1</a>. Schema ...................................................<a href="#page-62">62</a>
   <a href="#section-12">12</a>. IANA Considerations ...........................................<a href="#page-73">73</a>
      12.1. IANA Registration of MIME Media Type application/
            mediaservercontrol+xml ...................................<a href="#page-73">73</a>
   <a href="#section-13">13</a>. Security Considerations .......................................<a href="#page-74">74</a>
   <a href="#section-14">14</a>. References ....................................................<a href="#page-75">75</a>
      <a href="#section-14.1">14.1</a>. Normative References .....................................<a href="#page-75">75</a>
      <a href="#section-14.2">14.2</a>. Informative References ...................................<a href="#page-76">76</a>
   <a href="#appendix-A">Appendix A</a>.  Regex Grammar Syntax .................................<a href="#page-78">78</a>
   <a href="#appendix-B">Appendix B</a>.  Contributors .........................................<a href="#page-79">79</a>
   <a href="#appendix-C">Appendix C</a>.  Acknowledgements .....................................<a href="#page-79">79</a>

























<span class="grey">Van Dyke, et al.             Informational                      [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>.  Introduction</span>

   This document describes the Media Server Control Markup Language
   (MSCML) and its usage.  It describes payloads that one can send to a
   media server using standard SIP INVITE and INFO methods and the
   capabilities these payloads implement.  <a href="./rfc4240">RFC 4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>] describes media
   server SIP URI formats.

   Prior to MSCML, there was not a standard way to deliver SIP-based
   enhanced conferencing.  Basic SIP constructs, such as those described
   in <a href="./rfc4240">RFC 4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>], serve simple n-way conferencing well.  The SIP URI
   provides a natural mechanism for identifying a specific SIP
   conference, while INVITE and BYE methods elegantly implement
   conference join and leave semantics.  However, enhanced conferencing
   applications also require features such as sizing and resizing, in-
   conference IVR operations (e.g., recording and playing participant
   names to the full conference), and conference event reporting.  MSCML
   payloads within standard SIP methods realize these features.

   The structure and approach of MSCML satisfy the requirements set out
   in <a href="./rfc4353">RFC 4353</a> [<a href="#ref-10" title="&quot;A Framework for Conferencing with the Session Initiation Protocol (SIP)&quot;">10</a>].  In particular, MSCML serves as the interface
   between the conference server or focus and a centralized conference
   mixer.  In this case, a media server has the role of the conference
   mixer.

   There are two broad classes of MSCML functionality.  The first class
   includes primitives for advanced conferencing, such as conference
   configuration, participant leg manipulation, and conference event
   reporting.  The second class comprises primitives for interactive
   voice response (IVR).  These include collecting DTMF digits and
   playing and recording multimedia content.

   MSCML fills the need for IVR and conference control with requests and
   responses over a SIP transport.  VoiceXML [<a href="#ref-11" title="&quot;Voice Extensible Markup Language (VoiceXML) Version 2.0&quot;">11</a>] fills the need for IVR
   with requests and responses over a HTTP transport.  This enables
   developers to use whatever model fits their needs best.

   In general, a media server offers services to SIP UACs, such as
   Application Servers, Feature Servers, and Media Gateway Controllers.
   See the IPCC Reference Architecture [<a href="#ref-12" title="&quot;IPCC Reference Architecture V2&quot;">12</a>] for definitions of these
   terms.  It is unlikely, but not prohibited, for end-user SIP UACs to
   have a direct signaling relationship with a media server.  The term
   "client" is used in this document to refer generically to an entity
   that interacts with the media server using SIP and MSCML.







<span class="grey">Van Dyke, et al.             Informational                      [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   The media server fulfills the role of the Media Resource Function
   (MRF) in the IP Multimedia Subsystem (IMS) [<a href="#ref-13" title="&quot;Digital cellular telecommunications system (Phase 2+); Universal Mobile Telecommunications System (UMTS); IP Multimedia Subsystem (IMS); Stage 2 (3GPP TS 23.228 version 7.2.0 Release 7)&quot;">13</a>] as described by 3GPP.
   MSCML and <a href="./rfc4240">RFC 4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>], upon which MSCML builds, are specifically
   focused on the Media resource (Mr) interface which supports
   interactions between application logic and the MRF.

   This document describes a working framework and protocol with which
   there is considerable implementation experience.  Application
   developers and service providers have created several MSCML-based
   services since the availability of the initial version in 2001.  This
   experience is highly relevant to the ongoing work of the IETF,
   particularly the SIP [<a href="#ref-26">26</a>], SIPPING [<a href="#ref-27">27</a>], MMUSIC [<a href="#ref-28">28</a>], and XCON [<a href="#ref-29">29</a>]
   work groups, the IMS [<a href="#ref-30">30</a>] work in 3GPP, and the CCXML work in the
   Voice Browser Work Group of the W3C.

<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>.  Conventions Used in This Document</span>

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in <a href="./rfc2119">RFC 2119</a> [<a href="#ref-1" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">1</a>].

<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>.  MSCML Approach</span>

   It is critically important to emphasize that the goal of MSCML is to
   provide an application interface that follows the SIP, HTTP, and XML
   development paradigm to foster easier and more rapid application
   deployment.  This goal is reflected in MSCML in two ways.

   First, the programming model is that of peer to peer rather than
   master-slave.  Importantly, this allows the media server to be used
   simultaneously for multiple applications rather than be tied to a
   single point of control.  It also enables standard SIP mechanisms to
   be used for media server location and load balancing.

   Second, MSCML defines constructs and primitives that are meaningful
   at the application level to ensure that programmers are not
   distracted by unnecessary complexity.  For example, the mixing
   resource operates on constructs such as conferences and call
   participants rather than directly on individual media streams.

   The MSCML paradigm is important to the developer community, in that
   developers and operators conceptually write applications about calls,
   conferences, and call legs.  For the majority of developers and
   applications this approach significantly simplifies and speeds
   development.






<span class="grey">Van Dyke, et al.             Informational                      [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>.  Use of SIP Request Methods</span>

   As mentioned above, MSCML payloads may be carried in either SIP
   INVITE or INFO requests.  The initial INVITE, which creates an
   enhanced conference, MAY include an MSCML payload.  A subsequent
   INVITE to the same Request-URI joins a participant leg to the
   conference.  This INVITE MAY include an MSCML payload.  The initial
   INVITE that establishes an IVR session MUST NOT include an MSCML
   payload.  The client sends all mid-call MSCML payloads for
   conferencing and IVR via SIP INFO requests.

   SIP INVITE requests that contain both MSCML and Session Description
   Protocol (SDP) body parts are used frequently in conferencing
   scenarios.  Therefore, the media server MUST support message bodies
   with the MIME type "multipart/mixed" in SIP INVITE requests.

   The media server transports MSCML responses in the final response to
   the SIP INVITE containing the matching MSCML request or in a SIP INFO
   message.  The only allowable final response to a SIP INFO containing
   a message body is a 200 OK, per <a href="./rfc2976">RFC 2976</a> [<a href="#ref-3" title="&quot;The SIP INFO Method&quot;">3</a>].  Therefore, if the
   client sends the MSCML request via SIP INFO, the media server
   responds with the MSCML response in a separate INFO request.  In
   general, these responses are asynchronous in nature and require a
   separate transaction due to timing considerations.

   There has been considerable debate on the use of the SIP INFO method
   for any purpose.  Our experience is that MSCML would not have been
   possible without it.  At the time the first MSCML specification was
   published, the first SIP Event Notification draft had just been
   submitted as an individual submission.  At that time, there was no
   mechanism to link SUBSCRIBE/NOTIFY to an existing dialog.  This
   prevented its use in MSCML, since all events occurred in an INVITE-
   established dialog.  And while SUBSCRIBE/NOTIFY was well suited for
   reporting conference events, its semantics seemed inappropriate for
   modifying a participant leg or conference setting where the only
   "event" was the success or failure of the request.  Lastly, since SIP
   INFO was an established RFC, most SIP stack implementations supported
   it at that time.  We had few, if any, interoperability issues as a
   result.

   More recent developments have provided additional reasons why
   SUBSCRIBE/NOTIFY is not appropriate for use in MSCML.  Use of
   SUBSCRIBE presents two problems.  The first is semantic.  The purpose
   of SUBSCRIBE is to register interest in User Agent state.  However,
   using SUBSCRIBE for MSCML results in the SUBSCRIBE modifying the User
   Agent state.  The second reason SUBSCRIBE is not appropriate is
   because MSCML is inherently call based.  The association of a SIP
   dialog with a call leg means MSCML can be incredibly straightforward.



<span class="grey">Van Dyke, et al.             Informational                      [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   For example, if one used SUBSCRIBE or other SIP method to send
   commands about some context, one must identify that context somehow.
   Relating commands to the SIP dialog they arrive on defines the
   context for free.  Moreover, it is conceptually easy for the
   developer.  Using NOTIFY to transport MSCML responses is also not
   appropriate, as the NOTIFY would be in response to an implicit
   subscription.  The SIP and SIPPING lists have discussed the dangers
   of implicit subscription.

   In order to guarantee interoperability with this specification, as
   well as with SIP User Agents that are unaware of MSCML, SIP UACs that
   wish to use MSCML services MUST specify a service indicator that
   supports MSCML in the initial INVITE.  <a href="./rfc4240">RFC 4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>] defines the
   service indicator "conf", which MUST be used for MSCML conferencing
   applications.  The service indicator "ivr" MUST be used for MSCML
   interactive voice response applications.  In this specification, only
   "conf" and "ivr" are described.

   The media server MUST support moving the call between services
   through sending the media server a BYE on the existing dialog and
   establishing a new dialog with an INVITE to the desired service.
   Media servers SHOULD support moving between services without
   requiring modification of the previously established SDP parameters.
   This is achieved by sending a re-INVITE on the existing dialog in
   which the Request-URI is modified to specify the new service desired
   by the client.  This eliminates the need for the client to send an
   INVITE to the caller or gateway to establish new SDP parameters.

   The media server, as a SIP UAS, MUST respond appropriately to an
   INVITE that contains an MSCML body.  If MSCML is not supported, the
   media server MUST generate a 415 final response and include a list of
   the supported content types in the response per <a href="./rfc3261">RFC 3261</a> [<a href="#ref-4" title="&quot;SIP: Session Initiation Protocol&quot;">4</a>].  The
   media server MUST also advertise its support of MSCML in responses to
   OPTIONS requests, by including "application/mediaservercontrol+xml"
   as a supported content type in an Accept header.  This alleviates the
   major issues with using INFO for the transport of application data;
   namely, the User Agent's proper interpretation of what is, by design,
   an opaque message request.













<span class="grey">Van Dyke, et al.             Informational                      [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>.  MSCML Design</span>

<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>.  Transaction Model</span>

   To avoid undue complexity, MSCML establishes two rules regarding its
   usage.  The first is that only one MSCML body may be present in a SIP
   request.  The second is that each MSCML body may contain only one
   request or response.  This greatly simplifies transaction management.
   MSCML syntax does provide for the unique identification of multiple
   requests in a single body part.  However, this is not supported in
   this specification.

   Per the guidelines of <a href="./rfc3470">RFC 3470</a> [<a href="#ref-14" title="&quot;Guidelines for the Use of Extensible Markup Language (XML) within IETF Protocols&quot;">14</a>], MSCML bodies MUST be well formed
   and valid.

   MSCML is a direct request-response protocol.  There are no
   provisional responses, only final responses.  A request may, however,
   result in multiple notifications.  For example, a request for active
   talker reports will result in a notification for each speaker set.
   This maps to the three major element trees for MSCML: &lt;request&gt;,
   &lt;response&gt;, and &lt;notification&gt;.

   Figure 1 shows a request body.  Depending on the command, one can
   send the request in an INVITE or an INFO.  Figure 2 shows a response
   body.  The SIP INFO method transports response bodies.  Figure 3
   shows a notification body.  The SIP INFO method transports
   notifications.

   &lt;?xml version="1.0" encoding="utf-8"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       ... request body ...
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 1: MSCML Request Format

   &lt;?xml version="1.0" encoding="utf-8"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;response&gt;
       ... response body ...
     &lt;/response&gt;
   &lt;/MediaServerControl&gt;

   Figure 2: MSCML Response Format






<span class="grey">Van Dyke, et al.             Informational                      [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   &lt;?xml version="1.0" encoding="utf-8"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;notification&gt;
       ... notification body ...
     &lt;/notification&gt;
   &lt;/MediaServerControl&gt;

   Figure 3: MSCML Notification Format

   MSCML requests MAY include a client-defined ID attribute for the
   purposes of matching requests and responses.  The values used for
   these IDs need only be unique within the scope of the dialog in which
   the requests are issued.

<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>.  XML Usage</span>

   In the philosophy of XML as a text-based description language, and
   not as a programming language, MSCML makes the choice of many
   attribute values for readability by a human.  Thus, many attributes
   that would often be "boolean" instead take "yes" or "no" values.  For
   example, what does 'report="false"' or 'report="1"' mean?  However,
   'report="yes"' is clearer: I want a report.  Some programmers prefer
   the precision of a boolean.  To satisfy both styles, MSCML defines an
   XML type, "yesnoType", that takes on the values "yes" and "no" as
   well as "true", "false", "1", and "0".

   Many attributes in the MSCML schema have default values.  In order to
   limit demands on the XML parser, MSCML applies these values at the
   protocol, not XML, level.  The MSCML schema documents these defaults
   as XML annotations to the appropriate attribute.

<span class="h4"><a class="selflink" id="section-4.2.1" href="#section-4.2.1">4.2.1</a>.  MSCML Time Values</span>

   For clarity, time values in MSCML are based on the time designations
   described in the Cascading Style Sheets level 2 (CSS2) Specification
   [<a href="#ref-15" title="&quot;Cascading Style Sheets, level 2 (CSS2) Specification&quot;">15</a>].  Their format consists of a number immediately followed by an
   optional time unit identifier of the following form:

      ms: milliseconds (default)
      s: seconds

   If no time unit identifier is present, the value MUST be interpreted
   as being in milliseconds.  As extensions to [<a href="#ref-15" title="&quot;Cascading Style Sheets, level 2 (CSS2) Specification&quot;">15</a>] MSCML allows the
   string values "immediate" and "infinite", which have special meaning
   for certain timers.






<span class="grey">Van Dyke, et al.             Informational                      [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>.  Advanced Conferencing</span>

<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>.  Conference Model</span>

   The advanced conferencing model is a star controller model, with both
   signaling and media directed to a central location.  Figure 4 depicts
   a typical signaling relationship between end users' UACs, a
   conference application server, and a media server.

   <a href="./rfc4353">RFC 4353</a> [<a href="#ref-10" title="&quot;A Framework for Conferencing with the Session Initiation Protocol (SIP)&quot;">10</a>] describes this model.  The application server is an
   instantiation of the conference focus.  The media server is an
   instantiation of the media mixer.  Note that user-level constructs,
   such as event notifications, are in the purview of the application
   server.  This is why, for example, the media server sends active
   talker reports using MSCML notifications, while the application
   server would instead use the conference package [<a href="#ref-16" title="&quot;A Session Initiation Protocol (SIP) Event Package for Conference State&quot;">16</a>] for individual
   notifications to SIP user agents.  Note that we do not recommend the
   use of the conference package for media server to application server
   notifications because none of the filtering and membership
   information is available at the media server.

      +-------+
      | UAC 1 |---\   Public URI  +-------------+
      +-------+    \ _____________| Application |
                    /    /        |   Server    |     Not shown:
      +-------+    /    /         +-------------+     RTP flows directly
      | UAC 2 |---/    /                 | Private    between UACs and
      +-------+       /                  |   URI      media server
          .          /            +--------------+
          :         /             |              |
      +-------+    /              | Media Server |
      | UAC n |---/               |              |
      +-------+                   +--------------+

                          Figure 4: Conference Model

   Each UAC sends an INVITE to a Public Conference URI.  Presumably, the
   client publishes this URI, or it is an ad hoc URI.  In any event, the
   client generates a Private URI, following the rules specified by <a href="./rfc4240">RFC</a>
   <a href="./rfc4240">4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>].  That is, the URI is of the following form:

   sip:conf=UniqueID@ms.example.net

   where UniqueID is a unique conference identifier and ms.example.net
   is the host name or IP address of the media server.  There is nothing
   to prevent the UACs from contacting the media server directly.
   However, one would expect the owner of the media server to restrict
   who can use its resources.



<span class="grey">Van Dyke, et al.             Informational                     [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   As for basic conferencing, described by <a href="./rfc4240">RFC 4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>], the first
   INVITE to the media server with a UniqueID creates a conference.
   However, in advanced conferencing, the first INVITE MAY include a
   MSCML &lt;configure_conference&gt; payload rather than the SDP of a
   conference participant.  The &lt;configure_conference&gt; payload conveys
   extended session parameters (e.g., number of participants) that SDP
   does not readily express, but the media server must know to allocate
   the appropriate resources.

   When the conference is created by sending an INVITE containing a
   MSCML &lt;configure_conference&gt; payload, the resulting SIP dialog is
   termed the "Conference Control Leg."  This leg has several useful
   properties.  The lifetime of the conference is the same as that of
   its control leg.  This ensures that the conference remains in
   existence even if all participant legs leave or have not yet arrived.
   In addition, when the client terminates the Conference Control Leg,
   the media server automatically terminates all participant legs.  The
   Conference Control Leg is also used for play or record operations
   to/from the entire conference and for active talker notifications.
   Full conference media operations and active talker report
   subscriptions MUST be executed on the Conference Control Leg.

   Creation of a Conference Control Leg is RECOMMENDED because full
   advanced conferencing capabilities are not available without it.
   Clients MUST establish the Conference Control Leg in the initial
   INVITE that creates the conference; it cannot be created later.

   Once the client has created the conference with or without the
   Conference Control Leg, participants can be joined to the conference.
   This is achieved by the client's directing an INVITE to the Private
   Conference URI for each participant.  Using the example conference
   URI given above, this would be sip:conf=UniqueID@ms.example.net.

<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>.  Configure Conference Request &lt;configure_conference&gt;</span>

   The &lt;configure_conference&gt; request has two attributes that control
   the resources the media server sets aside for the conference.  These
   are described in the list below.

   Attributes of &lt;configure_conference&gt;:

   o  reservedtalkers - optional (see note), no default value: The
      maximum number of talker legs allocated for the conference.  Note:
      required when establishing the Conference Control Leg but optional
      in subsequent &lt;configure_conference&gt; requests.






<span class="grey">Van Dyke, et al.             Informational                     [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   o  reserveconfmedia - optional, default value "yes": Controls
      allocation of resources to enable playing or recording to or from
      the entire conference.

   When the reservedtalkers+1st INVITE arrives at the media server, the
   media server SHOULD generate a 486 Busy Here response.  Failure to
   send a 486 response to this condition can cause the media server to
   oversubscribe its resources.

      NOTE: It would be symmetric to have a reservedlisteners parameter.
      However, the practical limitation on the media server is the
      number of talkers for a mixer to monitor.  In either case, the
      client regulates who gets into the conference by either proxying
      the INVITEs from the user agent clients or metering to whom it
      gives the conference URI.

   For example, to create a conference with up to 120 active talkers and
   the ability to play audio into the conference or record portions or
   all of the conference full mix, the client specifies both attributes,
   as shown in Figure 6.

   &lt;?xml version="1.0" encoding="utf-8"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;configure_conference reservedtalkers="120"
         reserveconfmedia="yes"/&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 6: 120 Speaker MSCML Example

   In addition to these attributes, a &lt;configure_conference&gt; request MAY
   contain a child &lt;subscribe&gt; element.  The &lt;subscribe&gt; element is used
   to request notifications for conference-wide active talker events.
   Detailed information regarding active talker events is contained in
   <a href="#section-5.7">Section 5.7</a>.

   The client MUST include a &lt;configure_conference&gt; request in the
   initial INVITE which establishes the conference when creating the
   Conference Control Leg. The client server MUST issue asynchronous
   commands, such as &lt;play&gt;, separately (i.e., in INFO messages) to
   avoid ambiguous responses.

   Media operations on the Conference Control leg are performed
   internally, no external RTP streams are involved.  Accordingly, the
   media server does not expect RTP on the Conference Control Leg.
   Therefore, the client MUST send either no SDP or hold SDP in the
   INVITE request containing a &lt;configure_conference&gt; payload.  The



<span class="grey">Van Dyke, et al.             Informational                     [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   media server MUST treat SDP with all media lines set to "inactive" or
   with connection addresses set to 0.0.0.0 (for backwards
   compatibility) as hold SDP.

   The media server sends a response when it has finished processing the
   &lt;configure_conference&gt; request.  The format of the
   &lt;configure_conference&gt; response is detailed in <a href="#section-10.2">Section 10.2</a>.

<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>.  Configure Leg Request &lt;configure_leg&gt;</span>

   Conference legs have a number of properties the client can modify.
   These are set using the &lt;configure_leg&gt; request.  This request has
   the attributes described in the list below.

   Attributes of &lt;configure_leg&gt;:

   o  type - optional, default value "talker": Consider this leg's audio
      for inclusion in the output mix.  Alternative is "listener".

   o  dtmfclamp - optional, default value "yes": Remove detected DTMF
      digits from the input audio.

   o  toneclamp - optional, default value "yes": Remove tones from the
      input audio.  Tones include call progress tones and the like.

   o  mixmode - optional, default value "full": Be a candidate for the
      full mix.  Alternatives are "mute", to disallow media in the mix,
      "parked", to disconnect the leg's media streams from the
      conference for IVR operations, "preferred", to give this stream
      preferential selection in the mix (i.e., even if not loudest
      talker, include media, if present, from this leg in the mix), and
      "private", which enables personalized mixes.

   In addition to these attributes, there are four child elements
   defined for &lt;configure_leg&gt;.  These are &lt;inputgain&gt;, &lt;outputgain&gt;,
   &lt;configure_team&gt;, and &lt;subscribe&gt;.

   The first two, &lt;inputgain&gt; and &lt;outputgain&gt;, modify the gain applied
   to the input and output audio streams, respectively.  These may
   contain &lt;auto&gt;, to use automatic gain control (AGC) or &lt;fixed&gt;.  The
   &lt;auto&gt; element has the attributes "startlevel", "targetlevel", and
   "silencethreshold".  All the parameters are in dB.  The &lt;fixed&gt;
   element has the attribute "level", which is in dB.  The default for
   both &lt;inputgain&gt; and &lt;outputgain&gt; is &lt;fixed&gt;.  The media server MAY







<span class="grey">Van Dyke, et al.             Informational                     [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   silently cap &lt;inputgain&gt; or &lt;outputgain&gt; requests that exceed the
   gain limits imposed by the platform.

   Clients most commonly manipulate only the input gain for a conference
   leg and rely on the mixer to set an optimum output gain based on the
   inputs currently in the mix.  However, as described above, MSCML does
   allow for manipulation of the output gain as well.  Some of the IVR
   commands, such as &lt;play&gt;, enable control of the output gain for
   content playback operations.  The interaction of conference output
   gain and IVR playback gain controls is described in <a href="#section-6.1.1">Section 6.1.1</a>.
   Note that &lt;inputgain&gt; and &lt;outputgain&gt; settings apply only to
   conference legs and do not apply to IVR sessions.

   The &lt;configure_team&gt; element is used to create and manipulate groups
   for personalized mixes.  Details of personalized mixes are discussed
   in <a href="#section-5.8">Section 5.8</a>.

   The &lt;subscribe&gt; element is used to request notifications for call leg
   related events, such as asynchronous DTMF digit reports.  Detailed
   information regarding call leg events is discussed in <a href="#section-7">Section 7</a>.

   If the default parameters are acceptable for the leg the client
   wishes to enter into the conference, then a normal SIP INVITE, with
   no MSCML body, is sufficient.  However, if the client wishes to
   modify one or more of the parameters, the client can include a MSCML
   body in addition to the SDP body.

   The client can modify the conference leg parameters during the
   conference by issuing a SIP INFO on the dialog representing the
   conference leg.  Of course, the client cannot modify SDP in an INFO
   message.

   The media server sends a response when it has finished processing the
   &lt;configure_leg&gt; request.  The format of the &lt;configure_leg&gt; response
   is detailed in <a href="#section-10.3">Section 10.3</a>.

<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>.  Terminating a Conference</span>

   To remove a leg from the conference, the client issues a SIP BYE
   request on the selected dialog representing the conference leg.

   The client can terminate all legs in a conference by issuing a SIP
   BYE request on the Conference Control Leg.  If one or more
   participants are still in the conference when the media server
   receives a SIP BYE request on the Conference Control Leg, the media
   server issues SIP BYE requests on all remaining conference legs to
   ensure cleanup of the legs.




<span class="grey">Van Dyke, et al.             Informational                     [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   The media server returns a 200 OK to the SIP BYE request as it sends
   BYE requests to the other legs.  This is because we cannot issue a
   provisional response to a non-INVITE request, yet the teardown of the
   other legs may exceed the retransmission timer limits of the original
   request.  While the conference is being cleaned up, the media server
   MUST reject any new INVITEs to the terminated conference with a 486
   Busy Here response.  This response indicates that the specified
   conference cannot accept any new members, pending deletion.

<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>.  Conference Manipulation</span>

   Once the conference has begun, the client can manipulate the
   conference as a whole or a particular participant leg by issuing
   commands on the associated SIP dialog.  For example, by sending MSCML
   requests on the Conference Control Leg the client can request that
   the media server record the conference, play a prompt to the
   conference, or request reports on active talker events.  Similarly,
   the client may mute a participant leg, configure a personalized mix
   or request reports for call leg events, such as DTMF keypresses.

   Figure 7 shows an example of an MSCML command that plays a prompt to
   all conference participants.

   &lt;?xml version="1.0" encoding="utf-8"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;play&gt;
         &lt;prompt&gt;
           &lt;audio url="http://prompts.example.net/en_US/welcome.au"/&gt;
         &lt;/prompt&gt;
       &lt;/play&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 7: Full Conference Audio Command - Play

   A client can modify a leg by issuing an INFO on the dialog associated
   with the participant leg.  For example, Figure 8 mutes a conference
   leg.

   &lt;?xml version="1.0" encoding="utf-8"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;configure_leg mixmode="mute"/&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 8: Sample Change Leg Command



<span class="grey">Van Dyke, et al.             Informational                     [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   In Figure 7, we saw a request to play a prompt to the entire
   conference.  The client can also request to play a prompt to an
   individual call leg.  In that case, the MSCML request is issued
   within the SIP dialog of the desired conference participant.

   <a href="#section-6">Section 6</a> describes the interactive voice response (IVR) services
   offered by MSCML.  If an IVR command arrives on the control channel,
   it takes effect on the whole conference.  This is a mechanism for
   playing prompts to the entire conference (e.g., announcing new
   participants).  If an IVR command arrives on an individual leg, it
   only affects that leg.  This is a mechanism for interacting with
   users, such as the creation of "waiting rooms", allowing a user to
   mute themselves using key presses, allowing a moderator to out-dial,
   etc.

   A participant leg MUST be configured with mixmode="parked" prior to
   the issuance of any IVR commands with prompt content ('prompturl'
   attribute or &lt;prompt&gt; element).  Parking the leg isolates the
   participant's input and output media from the conference and allows
   use of those streams for playing and recording purposes.  However,
   the mixmode has no effect if just digit collection or recording is
   desired. &lt;playcollect&gt; and &lt;playrecord&gt; requests without prompt
   content MAY be sent on participant legs without setting
   mixmode="parked".

<span class="h3"><a class="selflink" id="section-5.6" href="#section-5.6">5.6</a>.  Video Conferencing</span>

   MSCML-controlled advanced conferences, as well as <a href="./rfc4240">RFC 4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>]
   controlled basic conferences, implicitly support video conferencing
   in the form of video switching.  In video switching, the video stream
   of the loudest talker (with some hysteresis) is sent to all
   participants other than that talker.  The loudest talker receives the
   video stream from the immediately prior loudest talker.

   Media servers MUST ensure that participants receive video media
   compatible with their session.  For example, a participant who has
   established an H.263 video stream will not receive video from another
   participant employing H.264 media.  Media servers SHOULD implement
   video transcoding to minimize media incompatibilities between
   participants.

   The media server MUST switch video streams only when it receives a
   refresh video frame.  A refresh frame contains all the video
   information required to decode that frame (i.e., there is no
   dependency on data from previous video frames).






<span class="grey">Van Dyke, et al.             Informational                     [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   Refresh frames are large and generally sent infrequently to conserve
   network bandwidth.  The media server MUST implement standard
   mechanisms to request that the new loudest talker's video encoder
   transmits a refresh frame to ensure that video can be switched
   quickly.

<span class="h3"><a class="selflink" id="section-5.7" href="#section-5.7">5.7</a>.  Conference Events</span>

   A client can subscribe for periodic active talker event reports that
   indicate which participants are included in the conference mix.  As
   these are conference-level events, the subscription and notifications
   are sent on the Conference Control Leg.

   Media servers MAY impose limits on the minimum interval for active
   talker reports for performance reasons.  If the client request is
   below the imposed minimum, the media server SHOULD set the interval
   to the minimum value supported.  To limit unnecessary notification
   traffic, the media server SHOULD NOT send a report if the active
   talker information for the conference has not changed during the
   reporting interval.

   A request for an active talker report is in Figure 9.  The active
   talker report enumerates the current call legs in the mix.

   &lt;?xml version="1.0" encoding="utf-8"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;configure_conference&gt;
         &lt;subscribe&gt;
           &lt;events&gt;
             &lt;activetalkers report="yes" interval="60s"/&gt;
           &lt;/events&gt;
         &lt;/subscribe&gt;
       &lt;/configure_conference&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 9: Active Talker Request

   Event notifications are sent in SIP INFO messages.  Figure 10 shows
   an example of a report.










<span class="grey">Van Dyke, et al.             Informational                     [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   &lt;?xml version="1.0" encoding="utf-8"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;notification&gt;
       &lt;conference uniqueid="ab34h76z" numtalkers="47"&gt;
         &lt;activetalkers&gt;
           &lt;talker callid="myhost4sn123"/&gt;
           &lt;talker callid="myhost2sn456"/&gt;
           &lt;talker callid="myhost12sn78"/&gt;
         &lt;/activetalkers&gt;
       &lt;/conference&gt;
     &lt;/notification&gt;
   &lt;/MediaServerControl&gt;

   Figure 10: Active Talker Event Example

   The value of the "callid" attribute in the &lt;talker&gt; element
   corresponds to the value of the SIP Call-ID header of the associated
   dialog.  This enables the client to associate the active talker with
   a specific participant leg.

<span class="h3"><a class="selflink" id="section-5.8" href="#section-5.8">5.8</a>.  Conferencing with Personalized Mixes</span>

   MSCML enables clients to create personalized mixes through the
   &lt;configure_team&gt; element for scenarios where the standard mixmode
   settings do not provide sufficient control.  The &lt;configure_team&gt;
   element is a child of &lt;configure_leg&gt;.

   To create personalized mixes, the client has to identify the
   relationships among the participants.  This is accomplished by
   manipulating two MSCML objects.  These objects are:

   1.  The list of team members (&lt;teammate&gt; elements), set using
       &lt;configure_team&gt;

   2.  The mixmode attribute set through &lt;configure_leg&gt;

   The media server uses the values of these objects to determine which
   audio inputs to combine for output to the participant.  In a normal
   conference, each participant hears the conference mix minus their own
   input if they are part of the mixed output.  The team list enables
   the client to specify other participants that the leg can hear in
   addition to the normal mixed output.  Note that personalized mix
   settings apply only to audio media and do not affect video switching.

   Team relationships are implicitly symmetric.  If the client sets
   participant A as a team member of participant B, then the media
   server automatically sets participant B as a team member for A.




<span class="grey">Van Dyke, et al.             Informational                     [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   The id attribute set through &lt;configure_leg&gt; is used to identify the
   various participants.  A unique ID MUST be assigned to each
   participant included in a personalized mix.  The IDs used MUST be
   unique within the scope of the conference in which they appear.

   By itself, the team list only defines those participants that the leg
   can hear.  The mixmode attribute of each team member determines
   whether to include their audio input in the personalized mix.  If the
   client sets the teammate's mixmode to private, then it is part of the
   mix.  If the mixmode is set to any other value, it is not.

<span class="h4"><a class="selflink" id="section-5.8.1" href="#section-5.8.1">5.8.1</a>.  MSCML Elements and Attributes for Personalized Mixes</span>

   Control of personalized mixes rely on two major MSCML elements:

   1.  &lt;configure_leg&gt;, using the mixmode attribute setting
       mixmode="private"

   2.  &lt;configure_team&gt;

   The &lt;configure_team&gt; element allows the user to make the participants
   members of a team within a specific conference.  It is a child of the
   &lt;configure_leg&gt; parent element.

   The client sends the &lt;configure_team&gt; element in a &lt;configure_leg&gt;
   request in either a SIP INVITE or SIP INFO.

   o  In an INVITE, to join a participant whose properties differ from
      the properties established for the conference as a whole.

   o  In an INFO, to change the properties for an existing leg.

   The two attributes of the configure_team element are "id" and
   "action".  The id attribute MUST contain the unique ID of the leg
   being modified, as set in the original &lt;configure_leg&gt; request.  The
   action attribute can take on the values "add", "delete", "query", and
   "set".  The default value is "query".  This attribute allows the user
   to modify the team list.  Table 1 describes the actions that can be
   performed on the team list.












<span class="grey">Van Dyke, et al.             Informational                     [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   +--------+----------------------------------------------------------+
   | Action | Description                                              |
   +--------+----------------------------------------------------------+
   | add    | Adds a teammate to the mix.                              |
   | delete | Deletes a teammate from the mix.                         |
   | query  | Returns the teammate list to the requestor.  This is the |
   |        | default value.                                           |
   | set    | Creates a team list when followed by &lt;teammate id="n"&gt;   |
   |        | and also removes all the teammates from the team list    |
   |        | for example, when the creator (originator) of the team   |
   |        | list on that specific conference leg wants to remove all |
   |        | of the teammates from the team.  If the set operation    |
   |        | removes all teammates from a participant, that           |
   |        | participant hears the full conference mix.               |
   +--------+----------------------------------------------------------+

                      Table 1: Configure Team Actions

<span class="h4"><a class="selflink" id="section-5.8.2" href="#section-5.8.2">5.8.2</a>.  Example Usage of Personalized Mixes</span>

   A common use of personalized mixing is to support coaching of one
   participant by another.  The coaching scenario includes three
   participants:
   1.  The Supervisor, who coaches the agent.
   2.  The Agent, who interacts with the customer.
   3.  The Customer, who interacts with the agent.

   Table 2 illustrates the details of the coached conference topology.

   +-------------+------------+------------+---------+-----------------+
   | Participant | ID         | Team       | Mixmode | Hears           |
   |             |            | Members    |         |                 |
   +-------------+------------+------------+---------+-----------------+
   | Supervisor  | supervisor | Agent      | Private | customer +      |
   |             |            |            |         | agent           |
   | Agent       | agent      | Supervisor | Full    | customer +      |
   |             |            |            |         | supervisor      |
   | Customer    | customer   | none       | Full    | agent           |
   +-------------+------------+------------+---------+-----------------+

                    Table 2: Coached Conference Example

   To create this topology, the client performs the following actions:

   1.  The client joins each leg to the conference, being certain to
       include a unique ID in the &lt;configure_leg&gt; request.  The leg ID
       needs to be unique only within the scope of the conference to
       which it belongs.



<span class="grey">Van Dyke, et al.             Informational                     [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   2.  The client configures the teammate list and mixmode of each
       participant, as required.

   Both actions (steps 1 and 2) may be combined in a single MSCML
   request.  The following sections detail these actions and their
   corresponding MSCML payloads.

<span class="h5"><a class="selflink" id="section-5.8.2.1" href="#section-5.8.2.1">5.8.2.1</a>.  Create the Conference</span>

   Before joining any participants, the client must create the
   conference by sending a SIP INVITE that contains an MSCML
   &lt;configure_conference&gt; request with a unique conference identifier.

<span class="h5"><a class="selflink" id="section-5.8.2.2" href="#section-5.8.2.2">5.8.2.2</a>.  Joining and Configuring the Coach</span>

   Join the coach leg to the conference and configure its desired
   properties by sending a SIP INVITE containing a &lt;configure_leg&gt;
   request.  The &lt;configure_leg&gt; element sets the leg's unique ID to
   supervisor and its mixmode to private.

   The corresponding MSCML request is as follows.

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;configure_leg id="supervisor" mixmode="private"/&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 11: Join Coach Request

   Note that the client cannot configure the teammate list for the coach
   yet, as there are no other participants in the conference.  One must
   join a participant to the conference before one can add it as a
   teammate for another leg.

<span class="h5"><a class="selflink" id="section-5.8.2.3" href="#section-5.8.2.3">5.8.2.3</a>.  Joining and Configuring the Agent</span>

   Join the agent leg to the conference and configure its desired
   properties by sending a SIP INVITE containing a &lt;configure_leg&gt;
   request.  The &lt;configure_leg&gt; element sets the leg's unique ID to
   "agent" and sets the supervisor as a team member of the agent.
   Because team member relationships are symmetric, this action also
   adds the agent as a team member for the coach.







<span class="grey">Van Dyke, et al.             Informational                     [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   The corresponding MSCML request is as follows.
   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
    &lt;request&gt;
       &lt;configure_leg id="agent"&gt;
         &lt;configure_team action="set"&gt;
           &lt;teammate id="supervisor"/&gt;
         &lt;/configure_team&gt;
       &lt;/configure_leg&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 12: Join Agent Request

   Because the desired mixmode for this leg is full, which is the
   default value, there is no need to set it explicitly.

<span class="h5"><a class="selflink" id="section-5.8.2.4" href="#section-5.8.2.4">5.8.2.4</a>.  Joining and Configuring the Client</span>

   Join the client leg to the conference and configure its desired
   properties by sending a SIP INVITE containing a &lt;configure_leg&gt;
   request.  The &lt;configure_leg&gt; element simply sets the leg's unique ID
   to "customer".  The media server does not need further configuration
   because the desired mixmode, full, is the default and the customer
   has no team members.

   The corresponding MSCML request is as follows.
   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;configure_leg id="customer"/&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 13: Join Client Request

   Strictly speaking, it is not a requirement that the client give the
   customer leg a unique ID because it will not be a team member.
   However, when using coached conferencing, we RECOMMEND that one
   assign a unique ID to each leg in the initial INVITE request.
   Assigning a unique ID eliminates the need to set it later by sending
   a SIP INFO if one later desires personalized mixing for the customer
   leg.

   The conference is now in the desired configuration, shown previously
   in Table 2.





<span class="grey">Van Dyke, et al.             Informational                     [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>.  Interactive Voice Response (IVR)</span>

   In the IVR model, the media server acts as a media-processing proxy
   for the UAC.  This is particularly useful when the UAC is a media
   gateway or other device with limited media processing capability.

   The typical use case for MSCML is when there is an application server
   that is the MSCML client.  The client can use the SIP Service URI
   concept (<a href="./rfc3087">RFC 3087</a>) to initiate a service.  The client then uses <a href="./rfc4240">RFC</a>
   <a href="./rfc4240">4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>] to initiate a MSCML session on a media server.  These
   relationships are shown in Figure 14.

                             SIP       +--------------+
                         Service URI   | Application  |
                      /----------------|    Server    |
                     /(e.g., <a href="./rfc3087">RFC 3087</a>) +--------------+
                    /                        |  MSCML
                   /                     SIP | Session
                  /                    +--------------+
          +-----+/       RTP           |              |
          | UAC |======================| Media Server |
          +-----+                      |              |
                                       +--------------+

                               Figure 14: IVR Model

   The IVR service supports basic Interactive Voice Response functions,
   playing announcements, collecting DTMF digits, and recording, based
   on Media Server Control Markup Language (MSCML) directives added to
   the message body of a SIP request.  The major MSCML IVR requests are
   &lt;play&gt;, &lt;playcollect&gt;, and &lt;playrecord&gt;.

   Multifunction media servers MUST use the URI conventions described in
   <a href="./rfc4240">RFC 4240</a> [<a href="#ref-2" title="&quot;Basic Network Media Services with SIP&quot;">2</a>].  The service indicator for MSCML IVR MUST be set to
   "ivr", as shown in the following example:

   sip:ivr@ms.example.net

   The VoiceXML IVR service indicator is "dialog".  This service
   indicator MUST NOT be used for any other interactive voice response
   control mechanism.

   The media server MUST accept MSCML IVR payloads in INFO requests and
   MUST NOT accept MSCML IVR payloads in the initial or subsequent
   INVITEs.  The INFO method reduces certain timing issues that occur
   with INVITEs and requires less processing on both the client and
   media server.




<span class="grey">Van Dyke, et al.             Informational                     [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   The media server notifies the client that the command has completed
   through a &lt;response&gt; message containing final status information and
   associated data such as collected DTMF digits.

   The media server does not queue IVR requests.  If the media server
   receives a new IVR request while another is in progress, the media
   server stops the first operation and it carries out the new request.
   The media server generates a &lt;response&gt; message for the first request
   and returns any data collected up to that point.  If a client wishes
   to stop a request in progress but does not wish to initiate another
   operation, it issues a &lt;stop&gt; request.  This also causes the media
   server to generate a &lt;response&gt; message.

   The media server treats a SIP re-INVITE that modifies the established
   SDP parameters as an implicit &lt;stop&gt; request.  Examples of such SDP
   modifications include receiving hold SDP or removing an audio or
   video stream.  When this occurs, the media server immediately
   terminates the running &lt;play&gt;, &lt;playcollect&gt;, or &lt;playrecord&gt; request
   and sends a &lt;response&gt; indicating "reason=stopped".

<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>.  Specifying Prompt Content</span>

   The MSCML IVR requests support two methods of specifying content to
   be delivered to the user.  These are the &lt;prompt&gt; element and the
   prompturl attribute.  Clients MUST NOT utilize both methods in a
   single IVR request.  Clients SHOULD use the more flexible &lt;prompt&gt;
   mechanism.  Use of the prompturl attribute is deprecated and may not
   be supported in future MSCML versions.

<span class="h4"><a class="selflink" id="section-6.1.1" href="#section-6.1.1">6.1.1</a>.  Use of the Prompt Element</span>

   The &lt;prompt&gt; element MAY be included in the body of a &lt;play&gt;,
   &lt;playcollect&gt;, or &lt;playrecord&gt; request to specify a prompt sequence
   to be delivered to the caller.  The prompt sequence consists of one
   or more references to physical content files, spoken variables, or
   dynamic URLs that return a sub-sequence of files or variables.  In
   addition, the &lt;prompt&gt; element has several attributes that control
   playback of the included content.  These are described in the list
   below.

   Attributes of &lt;prompt&gt;:

   o  baseurl - optional, no default value: For notational convenience,
      as well as reducing the MSCML payload size, the "baseurl"
      attribute is used to specify a base URL that is prepended to any
      other URLs in the sequence that are not fully qualified.





<span class="grey">Van Dyke, et al.             Informational                     [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   o  delay - optional, default value "0": The "delay" attribute to the
      prompt element specifies the time to pause between repetitions of
      the &lt;prompt&gt; sequence.  It has no effect on the first iteration of
      the sequence.  Expressed as a time value (<a href="#section-4.2.1">Section 4.2.1</a>) from 0
      onwards.

   o  duration - optional, default value "infinite": The "duration"
      attribute to the prompt element controls the maximum amount of
      time that may elapse while the media server repeats the sequence.
      This allows the client to set an upper bound on the length of
      play.  Expressed as a time value (<a href="#section-4.2.1">Section 4.2.1</a>) from 1ms onwards
      or the strings "immediate" and "infinite".  "Immediate" directs
      the media server to end play immediately, whereas "infinite"
      indicates that the media server imposes no limit.

   o  gain - optional, default value "0": Sets the absolute gain to be
      applied to the content contained in &lt;prompt&gt;.  The value of this
      attribute is specified in units of dB.  The media server MAY
      silently cap values that exceed the gain limits imposed by the
      platform.  The level reverts back to its original value when
      playback of the content contained in &lt;prompt&gt; has been completed.

   o  gaindelta - optional, default value "0": Sets the relative gain to
      be applied to the content contained in &lt;prompt&gt;.  The value of
      this attribute is specified in units of dB.  The media server MAY
      silently cap values which exceed the gain limits imposed by the
      platform.  The level reverts back to its original value when
      playback of the content contained in &lt;prompt&gt; has been completed.

   o  rate - optional, default value "0": Specifies the absolute
      playback rate of the content relative to normal as either a
      positive percentage (faster) or a negative percentage (slower).
      Any value that attempts to set the rate above the maximum allowed
      or below the minimum allowed silently sets the rate to the maximum
      or minimum.  The rate reverts back to its original value when
      playback of the content contained in &lt;prompt&gt; has been completed.

   o  ratedelta - optional, default value "0": Specifies the playback
      rate of the content relative to it's current rate as either a
      positive percentage (faster) or negative percentage (slower).  Any
      value that attempts to set the rate above the maximum allowed or
      below the minimum allowed silently sets the rate to the maximum or
      minimum.  The rate reverts back to its original value when
      playback of the content contained in &lt;prompt&gt; has completed.







<span class="grey">Van Dyke, et al.             Informational                     [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   o  locale - optional, no default value: Specifies the language and
      country variant used for resolving spoken variables.  The language
      is defined as a two-letter code per ISO 639.  The country variant
      is also defined as a two-letter code per ISO 3166.  These codes
      are concatenated with a single underscore (%x5F) character.

   o  offset - optional, default value "0": A time value (<a href="#section-4.2.1">Section 4.2.1</a>)
      which specifies the time from the beginning of the sequence at
      which play is to begin.  Offset only applies to the first
      repetition; subsequent repetitions begin play at offset 0.
      Allowable values are positive time values from 0 onwards.  When
      the sequence consists of multiple content files, the offset may
      select any point in the sequence.  If the offset value is greater
      than the total time of the sequence, it will "wrap" to the
      beginning and continue from there until the media server reaches
      the specified offset.

   o  repeat - optional, default value "1": The "repeat" attribute to
      the prompt element controls the number of times the media server
      plays the sequence in the &lt;prompt&gt; element.  Allowable values are
      integers from 0 on and the string "infinite", which indicates that
      repetition should occur indefinitely.  For example, "repeat=2"
      means that the sequence will be played twice, and "repeat=0",
      which is allowed, means that the sequence is not played.

   o  stoponerror - optional, default value "no": Controls media server
      handling and reporting of errors encountered when retrieving
      remote content.  If set to "yes", content play will end if a fetch
      error occurs, and the response will contain details regarding the
      failure.  If set to "no", the media server will silently move on
      to the next URL in the sequence if a fetch failure occurs.

   Clients MUST NOT include both 'gain' and 'gaindelta' attributes
   within a single &lt;prompt&gt; element.

   When the client explicitly controls the output gain on a conference
   leg, as described in <a href="#section-5.3">Section 5.3</a>, the 'gain' and 'gaindelta'
   attributes SHOULD interact with the conference leg output gain
   settings in the following manner.

   o  Conference leg output gain set to &lt;fixed&gt;: The operation of the
      'gain' and 'gaindelta' attributes are unchanged.  However, the
      baseline gain value before any playback changes are applied is the
      value specified for the conference leg.

   o  Conference leg output gain set to &lt;auto&gt;: When playback gain
      controls are used, the automatic gain control settings for the leg
      are suspended for the duration of the playback operation.  The



<span class="grey">Van Dyke, et al.             Informational                     [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


      operation of the 'gain' and 'gaindelta' attributes are unchanged.
      The automatic gain control settings are reinstated when playback
      has finished.

   Media servers SHOULD support rate controls for content.  However,
   media servers MAY silently ignore rate change requests if content
   limitations do not allow the request to be honored.  Clients MUST NOT
   include both 'rate' and 'ratedelta' attributes within a single
   &lt;prompt&gt; element.

   Figure 16 shows a sample prompt block.

   &lt;prompt stoponerror="yes"
     baseurl="file:////var/mediaserver/prompts/"
     locale="en_US" offset="0" gain="0" rate="0"
     delay="0" duration="infinite" repeat="1"&gt;
     &lt;audio url="num_dialed.raw" encoding="ulaw"/&gt;
     &lt;variable type="dig" subtype="ndn" value="3014170700"/&gt;
     &lt;audio url="num_invalid.wav"/&gt;
     &lt;audio url="please_check.wav"/&gt;
   &lt;/prompt&gt;

   Figure 16: Prompt Block Example

<span class="h5"><a class="selflink" id="section-6.1.1.1" href="#section-6.1.1.1">6.1.1.1</a>.  &lt;audio&gt; and &lt;variable&gt; Elements</span>

   Clients compose prompt sequences using the &lt;audio&gt; and &lt;variable&gt;
   elements.  An &lt;audio&gt; element MAY refer to content that contains
   audio, video, or both; the generic name is preserved for backwards
   compatibility.  The &lt;audio&gt; element has the attributes described in
   the list below.

   Attributes of &lt;audio&gt;:

   o  url - required, no default value: The URL of the content to be
      retrieved and played.  The target may be a local or remote (NFS)
      "file://" scheme URL or an "http://" or "https://" scheme URL.  If
      the URL is not fully qualified and a "baseurl" attribute was set,
      the value of the "baseurl" attribute will be prepended to this
      value to generate the target URL.

   o  encoding - optional, default value "ulaw": Specifies the content
      encoding for file formats that are not self-describing (e.g.,
      .WAV).  Allowable values are "ulaw", "alaw", and "msgsm".  This
      attribute only affects "file://" scheme URLs.

   o  gain - optional, default value "0": Sets the absolute gain to be
      applied to the content URL.  The value of this attribute is



<span class="grey">Van Dyke, et al.             Informational                     [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


      specified in units of dB.  The media server MAY silently cap
      values that exceed the gain limits imposed by the platform.  The
      level reverts back to its original value when playback of the
      content URL has been completed.

   o  gaindelta - optional, default value "0": Sets the relative gain to
      be applied to the content URL.  The value of this attribute is
      specified in units of dB.  The media server MAY silently cap
      values that exceed the gain limits imposed by the platform.  The
      level reverts back to its original value when playback of the
      content URL has been completed.

   o  rate - optional, default value "0": Specifies the absolute
      playback rate of the content relative to normal as either a
      positive percentage (faster) or a negative percentage (slower).
      Any value that attempts to set the rate above the maximum allowed
      or below the minimum allowed silently sets the rate to the maximum
      or minimum.  The rate reverts back to its original value when
      playback of the content URL has been completed.

   o  ratedelta - optional, default value "0": Specifies the playback
      rate of the content relative to it's current rate as either a
      positive percentage (faster) or a negative percentage (slower).
      Any value that attempts to set the rate above the maximum allowed
      or below the minimum allowed silently sets the rate to the maximum
      or minimum.  The rate reverts back to its original value when
      playback of the content URL has been completed.

   Clients MUST NOT include both 'gain' and 'gaindelta' attributes
   within a single &lt;audio&gt; element.

   When the client explicitly controls the output gain on a conference
   leg, as described in <a href="#section-5.3">Section 5.3</a>, the 'gain' and 'gaindelta'
   attributes SHOULD interact with the conference leg output gain
   settings in the following manner.

   o  Conference leg output gain set to &lt;fixed&gt;: The operation of the
      'gain' and 'gaindelta' attributes are unchanged.  However, the
      baseline gain value before any playback changes are applied is the
      value specified for the conference leg.

   o  Conference leg output gain set to &lt;auto&gt;: When playback gain
      controls are used, the automatic gain control settings for the leg
      are suspended for the duration of the playback operation.  The
      operation of the 'gain' and 'gaindelta' attributes are unchanged.
      The automatic gain control settings are reinstated when playback
      has finished.




<span class="grey">Van Dyke, et al.             Informational                     [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   Media servers SHOULD support rate controls for content.  However,
   media servers MAY silently ignore rate change requests if content
   limitations do not allow the request to be honored.  Clients MUST NOT
   include both 'rate' and 'ratedelta' attributes within a single
   &lt;audio&gt; element.

   Media servers MUST support local and remote (NFS) "file://" scheme
   URLs and "http://" and "https://" scheme URLs for content retrieval.

      NOTE: The provisioning of NFS mount points and their mapping to
      the "file://" schema is purely a local matter at the media server.

   MSCML also supports "http://" and "https://" scheme URLS that return
   a list of physical URLs using the "text/uri-list" MIME type.  This
   facility provides flexibility for applications to dynamically
   generate prompt sequences at execution time and enables separation of
   this function from the client and media server.

   Spoken variables are specified using the &lt;variable&gt; element.  This
   element has the attributes described in the list below.  MSCML's
   spoken variables are based on those described in Audio Server
   Protocol [<a href="#ref-17" title="&quot;Audio Server Protocol&quot;">17</a>].

   Attributes of &lt;variable&gt;:

   o  type - required, no default value: Specifies the major type format
      of the spoken variable to be played.  Allowable values are "dat"
      (date), "dig" (digit), "dur" (duration), "mth" (month), "mny"
      (money), "num" (number), "sil" (silence), "str" (string), "tme"
      (time), and "wkd" (weekday).

   o  subtype - optional, no default value: Specifies the minor type
      format of the spoken variable to be played.  Allowable values
      depend on the value of the corresponding "type" attribute.
      Possible values are "mdy", "ymd", and "dmy" for dates, "t12" and
      "t24" for times, "gen", "ndn", "crd", and "ord" for digits, and
      "USD" for money.

   o  value - required, no default value: A string that will be
      interpreted based on the formatting information specified in the
      "type" and "subtype" attributes and the "locale" attribute of the
      parent &lt;prompt&gt; element to render the spoken variable.

   If the "locale" attribute was not specified in &lt;prompt&gt;, the media
   server SHOULD make a selection based on platform configuration.  If
   the precise "locale" requested cannot be honored, the media server
   SHOULD select the closest match based on the available content.




<span class="grey">Van Dyke, et al.             Informational                     [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   IVR applications normally require specialized prompt content that is
   authored by the application provider.  To deliver a quality user
   interaction, the specialized prompts and spoken variables must be
   generated by the same speaker.  Since the media server inherently
   supports multiple simultaneous applications, it is extremely
   difficult to provision all the necessary application prompts and
   matching spoken variable content locally on the media server.
   Therefore, we STRONGLY RECOMMEND that clients employ the dynamic URL
   mechanism described earlier to generate spoken variables using an
   external web server that returns "text/uri-list" content.

<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>.  Multimedia Processing for IVR</span>

   MSCML IVR requests implicitly support multimedia content.  Multimedia
   capabilities are controlled by the audio and video media negotiated
   for the dialog and the content specified by the client for play and
   record operations.  If the content specified for delivery contains
   both audio and video tracks and the dialog has audio and video
   streams, both tracks are streamed to the caller.  Likewise, if the
   dialog has both audio and video streams and the content format
   specified supports both (e.g., .3gp files) the media server records
   both streams to the file.

   If there is a mismatch between the real time media and specified
   content, the media server MUST play or record the appropriate content
   tracks rather than failing the request.  For example, if the client
   has requested playback of content with audio and video tracks but
   only audio media has been established for the dialog, the media
   server should play the audio track.  If the dialog has both audio and
   video media but the content is audio-only, the media server MAY
   stream a pre-provisioned video track to the caller.  Media servers
   SHOULD implement video transcoding functions to minimize
   incompatibilities between real time media and content.

   The media server MUST begin recording video media only when it
   receives a refresh video frame.  A refresh frame contains all the
   video information required to decode that frame (i.e., there is no
   dependency on data from previous video frames).  Refresh frames are
   large and generally sent infrequently to conserve network bandwidth.
   The media server MUST implement standard mechanisms to request that
   the caller (video encoder) transmit a refresh frame to ensure video
   recording begins quickly.  The media server MUST begin recording the
   audio track immediately while waiting to receive the video refresh
   frame.







<span class="grey">Van Dyke, et al.             Informational                     [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>.  Playing Announcements &lt;play&gt;</span>

   The client issues a &lt;play&gt; request to play an announcement without
   interruption and with no digit collection.  One use, for example, is
   to announce the name of a new participant to the entire conference.
   The &lt;play&gt; request has the attributes described in the list below.

   Attributes of &lt;play&gt;:

   o  id - optional, no default value: Specifies a client-defined ID for
      purposes of matching requests and responses.

   o  offset - optional, default value "0": Specifies the time from the
      beginning of the URL specified in the 'prompturl' attribute at
      which play will begin.  Expressed as a time value (<a href="#section-4.2.1">Section 4.2.1</a>)
      from 0 onwards.  If the offset value is greater than the total
      time of the content, it will "wrap" to the beginning and continue
      from there until the media server reaches the specified offset.
      NOTE: Use of this attribute is deprecated.

   o  promptencoding - optional, no default value: Specifies the content
      encoding for file formats that are not self-describing (e.g.,
      .WAV).  Allowable values are "ulaw", "alaw", and "msgsm".  This
      attribute only affects "file://" scheme URLs.  NOTE: Use of this
      attribute is deprecated.

   o  prompturl - optional, no default value: The URL of the content to
      be retrieved and played.  The target may be a local or remote
      (NFS) "file://" scheme URL or an "http://" or "https://" scheme
      URL.  NOTE: Use of this attribute is deprecated.

   The &lt;play&gt; request has one child element defined, &lt;prompt&gt;.  Use of
   &lt;prompt&gt; is described in <a href="#section-6.1.1">Section 6.1.1</a>.

   The client MUST NOT use both the &lt;prompt&gt; element and "prompturl"
   attribute in a single request.  As previously discussed, the
   "prompturl" attribute is supported for backwards compatibility with
   older MSCML applications, but its use is deprecated.  The more
   flexible &lt;prompt&gt; element SHOULD be used instead.

   The following play request (Figure 17) example shows the delivery of
   a complex prompt sequence consisting of content accessed via NFS and
   spoken variables.








<span class="grey">Van Dyke, et al.             Informational                     [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;play id="332985001"&gt;
         &lt;prompt stoponerror="yes"
           baseurl="file:////var/mediaserver/prompts/"
           locale="en_US" offset="0" gain="0" rate="0"
           delay="0" duration="infinite" repeat="1"&gt;
           &lt;audio url="num_dialed.raw" encoding="ulaw"/&gt;
           &lt;variable type="dig" subtype="ndn" value="3014170700"/&gt;
           &lt;audio url="num_invalid.wav"/&gt;
           &lt;audio url="please_check.wav"/&gt;
         &lt;/prompt&gt;
       &lt;/play&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 17: &lt;Play&gt; Request Example

   When the announcement has finished playing, the media server sends a
   &lt;response&gt; payload to the client in a SIP INFO message.  Details
   regarding the format of &lt;play&gt; responses are provided in <a href="#section-10.4">Section</a>
   <a href="#section-10.4">10.4</a>.

<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>.  Prompt and Collect &lt;playcollect&gt;</span>

   The client issues a &lt;playcollect&gt; request to play an announcement
   (optional) and collect digits.  The &lt;playcollect&gt; request is executed
   in two phases, prompt and collect.  If the client specifies prompt
   content to be played, using the &lt;prompt&gt; element or prompturl
   attribute, the media server plays the content before starting the
   collection phase.  If no prompt content is specified, the collect
   phase begins immediately.

   The basic attributes of &lt;playcollect&gt; are the same as those of
   &lt;play&gt;, which were described in <a href="#section-6.3">Section 6.3</a>.  In addition to these
   basic attributes, &lt;playcollect&gt; defines others which control digit
   buffering and barge-in behavior, collection timers, special purpose
   DTMF key functions, and logging of user DTMF input.  Each functional
   category and its attributes are described below.











<span class="grey">Van Dyke, et al.             Informational                     [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h4"><a class="selflink" id="section-6.4.1" href="#section-6.4.1">6.4.1</a>.  Control of Digit Buffering and Barge-In</span>

   Whenever the media server is processing a call that specifies an
   MSCML service (i.e., "conf" and "ivr"), the media server continuously
   looks for DTMF digits and places them in a quarantine buffer.  The
   quarantine buffer is examined when a &lt;playcollect&gt; request is
   received.  The media server compares any previously buffered digits
   for barge-in, and to look for matches with DTMF grammars or special
   purpose keys.  This provides the type-ahead behavior for menu
   traversal and other types of IVR interactions.

   Attributes for Control of Digit Buffering and Barge-In:

   o  cleardigits - optional, default value "no": Specifies whether
      previous user input should be considered or ignored for barge-in
      purposes and DTMF matching.  When it is set to "yes", any
      previously buffered digits are removed, so prior user input is
      ignored.  If it is set to "no", previously buffered digits will be
      considered.  If "cleardigits" is set to "no" and barge-in is
      enabled, previously buffered digits will immediately terminate the
      prompt phase.  In this case, the prompt is not played, and digit
      collection begins immediately.

   o  barge - optional, default value "yes": Specifies whether user
      input will barge the prompt and force transition to the collect
      phase.  When it is set to "yes", a DTMF input will barge the
      prompt.  When it is set to "no", the prompt phase cannot be
      barged, and any user input during the prompt is placed in the
      quarantine buffer for inspection during the collect phase.  Note
      that if the "barge" attribute is set to "no", the "cleardigits"
      attribute implicitly has a value of "yes".  This ensures that the
      media server does not leave DTMF input that occurred prior to the
      current collection in the quarantine buffer after the request is
      completed.

<span class="h4"><a class="selflink" id="section-6.4.2" href="#section-6.4.2">6.4.2</a>.  Mapping DTMF Keys to Special Functions</span>

   The client can define mappings between DTMF digits and special
   functions.  The media server invokes the special function if the
   associated DTMF digit is detected.  MSCML has two attributes that
   define mappings that affect termination of the collect phase.  These
   attributes are described in the list below.









<span class="grey">Van Dyke, et al.             Informational                     [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   DTMF Key Mappings for &lt;playcollect&gt;:

   o  escapekey - optional, default value "*": Specifies a DTMF key that
      indicates that the user wishes to terminate the current operation
      without saving any input collected to that point.  Detection of
      the mapped DTMF key terminates the request immediately and
      generates a response.

   o  returnkey - optional, default value "#": Specifies a DTMF key that
      indicates that the user has completed input and wants to return
      all collected digits to the client.  When the media server detects
      the returnkey, it immediately terminates collection and returns
      the collected digits to the client in the &lt;response&gt; message.

   MSCML defines three additional mappings to enable video cassette
   recorder (VCR) type controls while playing a prompt sequence.  Media
   servers SHOULD support VCR controls.  However, if the media server
   does not support VCR controls, it MUST silently ignore DTMF inputs
   mapped to VCR functions and complete the &lt;playcollect&gt; request.  The
   VCR control attributes are described in the list below.

   Attributes for VCR Controls:

   o  skipinterval - optional, default value "6s": The "skipinterval"
      attribute indicates how far the media server should skip backwards
      or forwards when the rewind key (rwkey) or fast forward key
      (ffkey) is pressed, specified as a time value (<a href="#section-4.2.1">Section 4.2.1</a>).

   o  ffkey - optional, no default value: The "ffkey" attribute maps a
      DTMF key to a fast forward operation equal to the value of the
      "skipinterval" attribute.

   o  rwkey - optional, no default value: The "rwkey" attribute maps a
      DTMF key to a rewind action equal to the value of the
      "skipinterval" attribute.

   Clients MUST NOT map the same DTMF digit to both the "rwkey" and
   "ffkey" attributes in a single &lt;playcollect&gt; request.

   VCR control operations are bounded by the beginning and end of the
   prompt sequence.  A rewind action that moves the offset before the
   beginning of the sequence results in playback starting at the
   beginning of the sequence (i.e., offset=0).  A fast forward action
   that moves the offset past the end of the sequence results in the
   media server's treating the sequence as complete.






<span class="grey">Van Dyke, et al.             Informational                     [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h4"><a class="selflink" id="section-6.4.3" href="#section-6.4.3">6.4.3</a>.  Collection Timers</span>

   MSCML defines several timer attributes that control how long the
   media server waits for digits in the input sequence.  All timer
   settings are time values (<a href="#section-4.2.1">Section 4.2.1</a>).  The list below describes
   these attributes and their use.

   Collection Timer Attributes:

   o  firstdigittimer - optional, default value "5000ms": Specifies how
      long the media server waits for the initial DTMF input before
      terminating the collection.  Expressed as a time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) from 1ms onwards or the strings "immediate" and "infinite."
      The value "immediate" indicates that the timer should fire
      immediately whereas "infinite" indicates that the timer will never
      fire.

   o  interdigittimer - optional, default value "2000ms": Specifies how
      long the media server waits between DTMF inputs.  Expressed as a
      time value (<a href="#section-4.2.1">Section 4.2.1</a>) from 1ms onwards or the strings
      "immediate" and "infinite."  The value "immediate" indicates that
      the timer should fire immediately, whereas "infinite" indicates
      that the timer will never fire.

   o  extradigittimer - optional, default value "1000ms": Specifies how
      long the media server waits for additional user input after the
      specified number of digits has been collected.  Expressed as a
      time value (<a href="#section-4.2.1">Section 4.2.1</a>) from 1ms onwards or the strings
      "immediate" and "infinite."  The value "immediate" indicates that
      the timer should fire immediately, whereas "infinite" indicates
      that the timer will never fire.

   o  interdigitcriticaltimer - optional, defaults to the value of the
      interdigittimer attribute: Specifies how long the media server
      waits after a grammar has been matched for a subsequent digit that
      may cause a longer match.  Expressed as a time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) from 1ms onwards or the strings "immediate" and "infinite."
      The value "immediate" results in "shortest match first" behavior,
      whereas "infinite" means to wait indefinitely for additional
      input.  If not explicitly specified otherwise, this attribute is
      set to the value of the 'interdigittimer' attribute.

   The extradigittimer setting enables the "returnkey" input to be
   associated with the current collection.  For example, if maxdigits is
   set to 3 and returnkey is set to #, the user may enter either "x#",
   "xx#", or "xxx#", where x represents a DTMF digit.





<span class="grey">Van Dyke, et al.             Informational                     [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   If the media server detects the "returnkey" pattern during the
   "extradigit" interval, the media server returns the collected digits
   to the client and removes the "returnkey" from the digit buffer.

   If this were not the case, the example would return "xxx" to the
   client and leave the terminating "#" in the digit buffer.  At the
   next &lt;playcollect&gt; request, the media server would process the '#'.
   This might result in the termination of the following prompt, which
   is clearly not what the user intended.

   The extradigittimer has no effect unless returnkey has been set.

<span class="h4"><a class="selflink" id="section-6.4.4" href="#section-6.4.4">6.4.4</a>.  Logging Caller DTMF Input</span>

   Standard SIP mechanisms, such as those discussed in Security
   Considerations (<a href="#section-14">Section 14</a>), protect MSCML protocol exchanges and the
   information they contain.  These protections do not apply to data
   captured in media server log files.  In general, media server logging
   is platform specific and therefore is not covered by this
   specification.  However, one aspect of logging, the capture of
   sensitive information (such as personal identification numbers or
   credit card numbers), is relevant.  The media server has no means to
   determine whether the DTMF input it receives may be sensitive, as
   that is in the purview of the client.  Recognizing this, MSCML
   includes a per-request mechanism to suppress logging of captured DTMF
   to be enabled by clients as needed.

   The "maskdigits" attribute controls whether detected DTMF digits
   appear in the log output.  Clients use this attribute when the media
   server collects sensitive information that should not be accessible
   through the log files.

   Maskdigits Attribute:

   o  maskdigits - optional, default value "no": Controls whether user
      DTMF inputs are captured in media server log files.  The possible
      values for this attribute are "yes" and "no".

<span class="h4"><a class="selflink" id="section-6.4.5" href="#section-6.4.5">6.4.5</a>.  Specifying DTMF Grammars</span>

   MSCML supports four methods for specifying DTMF grammars: the
   "maxdigits" attribute, which provides a simple mechanism for
   collecting any number of digits up to the maximum, regular
   expressions, MGCP [<a href="#ref-5" title="&quot;Network call signalling protocol for the delivery of time- critical services over cable television networks using cable modems&quot;">5</a>] digit maps, and H.248.1 [<a href="#ref-6" title="&quot;Gateway Control Protocol Version 1&quot;">6</a>] digit maps.  A
   media server MUST support the maxdigits and regular expression
   methods for specifying DTMF grammars and SHOULD support MGCP and
   H.248.1 methods.  A client MUST NOT mix DTMF grammar types in a
   single &lt;playcollect&gt; request.



<span class="grey">Van Dyke, et al.             Informational                     [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   Following is a description of the "maxdigits" attribute.

   Maxdigits Attribute:

   o  maxdigits - optional, no default value: Specifies the maximum
      number of DTMF digits to be collected.

   The &lt;pattern&gt; element specifies a digit pattern or patterns for the
   media server to look for.  This element may contain three different
   child elements that specify the type of DTMF grammar used in the
   expression.  The &lt;pattern&gt; element has no attributes.

   &lt;regex&gt; Use regular expressions to define DTMF patterns to match.
      The complete regular expression syntax used in MSCML is described
      in <a href="#appendix-A">Appendix A</a>.

   &lt;mgcpdigitmap&gt; Use digit maps as specified in MGCP [<a href="#ref-5" title="&quot;Network call signalling protocol for the delivery of time- critical services over cable television networks using cable modems&quot;">5</a>].

   &lt;megacodigitmap&gt; Use digit maps as specified in H.248.1 [<a href="#ref-6" title="&quot;Gateway Control Protocol Version 1&quot;">6</a>].

   At least one &lt;regex&gt; element MUST be present in &lt;pattern&gt; when regex
   grammars are used.  Multiple &lt;regex&gt; elements MAY be present.  When
   &lt;mgcpdigitmap&gt; or &lt;megacodigitmap&gt; grammars are used, &lt;pattern&gt; MUST
   contain only one grammar element.

   The DTMF grammar elements &lt;regex&gt;, &lt;mgcpdigitmap&gt;, and
   &lt;megacodigitmap&gt; have the attributes described in the list below.

   Attributes of DTMF Grammar Elements:

   o  value - required, no default value: Specifies a string
      representing a DTMF grammar matching the parent element type
      (e.g., regex).  Regex values represent a single DTMF grammar.
      MGCP and MEGACO digit maps allow multiple grammars to be described
      in a single string.

   o  name - optional, no default value: Associates a client defined
      name for the grammar that is sent back in the &lt;playcollect&gt;
      response.  This attribute is most useful with regex type grammars
      as each grammar element can have a unique name.

<span class="h4"><a class="selflink" id="section-6.4.6" href="#section-6.4.6">6.4.6</a>.  Playcollect Response</span>

   When the &lt;playcollect&gt; has finished, the media server sends a
   &lt;response&gt; payload to the client in a SIP INFO message.

   Details of the &lt;playcollect&gt; response are described in <a href="#section-10.5">Section 10.5</a>.




<span class="grey">Van Dyke, et al.             Informational                     [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h4"><a class="selflink" id="section-6.4.7" href="#section-6.4.7">6.4.7</a>.  Playcollect Example</span>

   The following &lt;playcollect&gt; request (Figure 18) example depicts use
   of the "maxdigits" attribute to control digit collection.

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;playcollect id="332986004" maxdigits="6" firstdigittimer="10000"
         interdigittimer="5000" extradigittimer="1000"
         interdigitcriticaltimer="1000" returnkey="#" escapekey="*"
         cleardigits="no" barge="yes" maskdigits="no"&gt;
         &lt;prompt baseurl="http://www.example.com/prompts/"&gt;
           &lt;audio url="generic/en_US/enter_pin.wav"/&gt;
         &lt;/prompt&gt;
       &lt;/playcollect&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 18: &lt;Playcollect&gt; Request Example Using the Maxdigits
   Attribute

<span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>.  Prompt and Record &lt;playrecord&gt;</span>

   The &lt;playrecord&gt; request directs the media server to convert and
   possibly to transcode the RTP payloads it receives and store them to
   the specified URL using the requested content codec(s) and file
   format.  This request proceeds in two phases; prompt and record.

   The &lt;playrecord&gt; request shares the basic attributes of &lt;play&gt; and
   &lt;playcollect&gt; as described in <a href="#section-6.3">Section 6.3</a>.  MSCML also defines other
   attributes that control the behavior of the prompt and recording
   phases.  These phases and the attributes that control them are
   described in the text and tables below.

<span class="h4"><a class="selflink" id="section-6.5.1" href="#section-6.5.1">6.5.1</a>.  Prompt Phase</span>

   The presence or absence of a "prompturl" attribute or child &lt;prompt&gt;
   element controls whether a prompt is played before recording begins.
   As previously noted, use of the "prompturl" attribute is deprecated,
   and clients SHOULD use &lt;prompt&gt; instead.

   When the client requests that the media server prompt the caller
   before recording audio, &lt;playrecord&gt; has two stages.  The first is
   equivalent to a &lt;playcollect&gt; operation.  The client may set the
   prompt phase to be interruptible by DTMF input (barge) and may
   specify an escape key that will terminate the &lt;playrecord&gt; request
   before the recording phase begins.



<span class="grey">Van Dyke, et al.             Informational                     [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   The list below describes the attributes of &lt;playrecord&gt; that specify
   the behavior of the prompt phase of the request.

   Playrecord Attributes for the Prompt Phase:

   o  barge - optional, default value "yes": Specifies whether user
      input will barge the prompt and force transition to the record
      phase.  When it is set to "yes", a DTMF input will barge the
      prompt.  When it is set to "no", the prompt phase cannot be
      barged, and any user input during the prompt is placed in the
      quarantine buffer for inspection during the collect phase.  Note
      that if the "barge" attribute is set to "no", the "cleardigits"
      attribute implicitly has a value of "yes".  This ensures that the
      media server does not leave DTMF input that occurred prior to the
      current collection in the quarantine buffer after the request
      completes.

   o  cleardigits - optional, default value "no": Specifies whether
      previous user input should be considered or ignored for barge-in
      purposes.  When it is set to "yes", any previously buffered digits
      are removed, so prior user input is ignored.  If it is set to
      "no", previously buffered digits will be considered.  If
      "cleardigits" is set to "no" and barge-in is enabled, previously
      buffered digits will terminate the prompt phase immediately.  In
      this case, the prompt is not played, and recording begins
      immediately.

   o  escapekey - optional, default value "*": Specifies a DTMF key that
      indicates the user wishes to terminate the current operation
      without saving any input recorded to that point.  Detection of the
      mapped DTMF key terminates the request immediately and generates a
      response.

   Detection of the escape key generates a response message, and the
   operation returns immediately.  If the user presses any other keys
   and if the prompt is interruptible (barge="yes"), then the play stops
   immediately, and the recording phase begins.

<span class="h4"><a class="selflink" id="section-6.5.2" href="#section-6.5.2">6.5.2</a>.  Record Phase</span>

   If the request proceeds to the recording phase, the media server
   discards any digits from the collect phase from the quarantine buffer
   to eliminate unintended termination of the recording.  The following
   attributes control recording behavior.

   Playrecord Attributes for the Record Phase:





<span class="grey">Van Dyke, et al.             Informational                     [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   o  recurl - required, no default value: Specifies the target URL for
      the recorded content.

   o  recencoding - optional, default value "ulaw": Specifies the
      encoding of the recorded content if it cannot be inferred from the
      recurl.  Possible values are "ulaw", "alaw", and "msgsm."

   o  mode - optional, default value "overwrite": Specifies whether the
      recording should overwrite or be appended to the target URL.
      Allowable values are "overwrite" and "append."

   o  duration - optional, default value "infinite": Specifies the
      maximum allowable duration for the recording.  Expressed as a time
      value (<a href="#section-4.2.1">Section 4.2.1</a>) from 1 onwards or the strings "immediate"
      and "infinite."  The value "immediate" indicates that recording
      will end immediately, whereas "infinite" indicates recording
      should continue indefinitely.  If the maximum duration is reached,
      the &lt;playrecord&gt; request will terminate and generate a response.

   o  beep - optional, default value "yes": Specifies whether a beep
      should be played to the caller immediately prior to the start of
      the recording phase.  Allowable values are "yes" and "no."

   o  initsilence - optional, default value "3000ms": Specifies how long
      to wait for initial speech input before terminating (canceling)
      the recording.  Expressed as a time value (<a href="#section-4.2.1">Section 4.2.1</a>) from 1ms
      onwards or the strings "immediate" and "infinite."  The value
      "immediate" indicates that the timer should fire immediately,
      whereas "infinite" directs the media server to wait indefinitely.

   o  endsilence - optional, default value "4000ms": Specifies how long
      the media server waits after speech has ended to stop the
      recording.  Expressed as a time value (<a href="#section-4.2.1">Section 4.2.1</a>) from 1ms
      onwards or the strings "immediate" and "infinite."  When set to
      "infinite", the recording will continue indefinitely after speech
      has ended and will only terminate due to a DTMF keypress or
      because the input has reached the maximum desired duration.

   o  recstopmask - optional, default value "0123456789ABCD#*":
      Specifies a list of individual DTMF characters that, if detected,
      will cause the recording to be terminated.  To ensure that the
      input of a specific key does not cause the recording to stop,
      remove the DTMF key from the list.

   Media servers MUST support local and remote (NFS) "file://" scheme
   URLs in the "recurl" attribute.  MSCML supports "http://" and
   "https://" scheme URLs indirectly through the &lt;managecontent&gt;
   (<a href="#section-8">Section 8</a>) request.



<span class="grey">Van Dyke, et al.             Informational                     [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   The media server buffers and returns any digits collected in the
   prompt phase, with the exception of those contained in the
   "recstopmask" attribute, in the response.

   The media server compares digits detected during the recording phase
   to the digits specified in the "recstopmask" to determine whether
   they indicate a recording termination request.

   The media server ignores digits not present in the recstopmask and
   passes them into the recording.  If DTMF input terminates the
   recording, the media server returns the collected digit to the client
   in the &lt;response&gt;.

   Once recording has begun, the media server writes the received media
   to the specified recurl URL no matter what DTMF events the media
   server detects.  It is the responsibility of the client to examine
   the DTMF input returned in the &lt;response&gt; message to determine
   whether the audio file should be saved or deleted and, potentially,
   re-recorded.

   If the endsilence timer expires, the media server trims the end of
   the recorded audio by an amount equal to the value of the
   "endsilence" attribute.

   When the recording is finished, the media server generates a
   &lt;response&gt; message and sends it to the client in a SIP INFO message.
   Details of the &lt;playrecord&gt; response are described in <a href="#section-10.6">Section 10.6</a>.

<span class="h4"><a class="selflink" id="section-6.5.3" href="#section-6.5.3">6.5.3</a>.  Playrecord Example</span>

   The recording example (Figure 19) plays a prompt and records it to
   the destination specified in the "recurl" attribute encoded as MS-GSM
   in wave format.


















<span class="grey">Van Dyke, et al.             Informational                     [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;playrecord id="5556123"
         recurl="file:////nfs.example.com/rec/name.wav"
         recencoding="msgsm"
         initsilence="5000" endsilence="3000" duration="30000"
         barge="yes"
         beep="yes"
         mode="overwrite"
         cleardigits="no"
         escapekey="*"
         recstopmask="0123456789#*"&gt;
         &lt;prompt&gt;
           &lt;audio url="http://www.example.com/prompts/recordname.wav"/&gt;
         &lt;/prompt&gt;
       &lt;/playrecord&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 19: Recording Example

<span class="h3"><a class="selflink" id="section-6.6" href="#section-6.6">6.6</a>.  Stop Request &lt;stop&gt;</span>

   The client issues a &lt;stop&gt; request when the objective is to stop a
   request in progress and not to initiate another operation.  This
   request generates a &lt;response&gt; message from the media server.

   The only attribute is id, which is optional.

   The client-defined request id correlates the asynchronous response
   with its original request and echoes back to the client in the media
   server's response.

   The following MSCML payload (Figure 20) depicts an example &lt;stop&gt;
   request.

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;stop id="4578903"/&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 20: Stop Example

   The format of a response to a &lt;stop&gt; request is detailed in <a href="#section-10.2">Section</a>
   <a href="#section-10.2">10.2</a>.



<span class="grey">Van Dyke, et al.             Informational                     [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   As discussed previously, the media server treats a SIP re-INVITE that
   modifies the established SDP parameters as an implicit &lt;stop&gt;
   request.  Examples of such SDP modifications include receiving hold
   SDP or removing an audio or video stream.  When this occurs, the
   media server immediately terminates the running &lt;play&gt;,
   &lt;playcollect&gt;, or &lt;playrecord&gt; request and sends a &lt;response&gt;
   indicating "reason=stopped".

<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>.  Call Leg Events</span>

   MSCML defines event notifications that are scoped to a specific SIP
   dialog or call leg.  These events allow a client to be notified of
   individual, asynchronous DTMF keypresses, as well as of various call
   progress signals.  The subscription, event detection, and
   notifications for call leg events occur in the same SIP dialog.  This
   is different from the conference level active talker events described
   earlier.  The subscription and notifications for active talker events
   occur on the conference control leg, but the actual event detection
   occurs on one or more participant legs.

   Subscriptions for call leg events are made by sending an MSCML
   &lt;configure_leg&gt; request on the desired SIP dialog.  Call leg events
   may be used with the MSCML conferencing or IVR services.  When used
   with the IVR service, the &lt;configure_leg&gt; request SHOULD NOT include
   any conference-related attributes.  The media server MUST ignore
   these if present.  Call leg event subscriptions MUST NOT be made on
   the conference control leg, since it has no actual RTP media to
   process for event detection.  The media server MUST reject a
   &lt;configure_leg&gt; request sent on the conference control leg.

   The &lt;configure_leg&gt; request contains the child elements &lt;subscribe&gt;
   and &lt;events&gt;.  The &lt;events&gt; element may contain two child elements
   that control subscriptions to call leg events.  These are &lt;keypress&gt;
   and &lt;signal&gt;.  A &lt;configure_leg&gt; request MUST contain at most one
   &lt;keypress&gt; element but MAY contain multiple &lt;signal&gt; elements that
   request notification of different call progress events.

<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>.  Keypress Events</span>

   Keypress events are used when the client wishes to receive
   notifications of individual DTMF events that are not tied to a
   specific &lt;playcollect&gt; request.  One use of this facility is to
   monitor conference legs for DTMF inputs that require application
   intervention; for example, to notify the moderator that the caller
   wishes to speak.  Keypress events are also used when the application
   desires complete control of grammars and timing constraints.





<span class="grey">Van Dyke, et al.             Informational                     [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   When used in a subscription context, the &lt;keypress&gt; element has two
   attributes, 'report' and 'maskdigits', which are detailed in the list
   below.

   Keypress Subscription Attributes:

   o  report - required, no default value: Possible values are
      'standard', 'long', 'both', and 'none'.  'Standard' means that
      detected digits should be reported.  'Long' means that long digits
      should be reported.  'Long' digits are defined as a single key
      press held down for more than one second, or two distinct key
      presses (a "double") of the same digit that occur within two
      seconds of each other with no other intervening digits.  'Both'
      means that both 'standard' and 'long' digit events should be
      reported.  As a 'long' digit consists of one or more "normal"
      digits, a single long duration key press will generate one
      standard event and one 'long' event.  A "double" will produce two
      standard events and one 'long' event.  'None' means that no
      keypress events should be reported; it disables keypress event
      reporting if enabled.

   o  maskdigits - optional, default value "no": Controls whether user
      DTMF inputs are captured in media server log files.  The possible
      values for this attribute are "yes" and "no".

   The media server sends an MSCML response to the subscription
   immediately upon receiving the request.  Notifications are sent to
   the client when the specified events are detected.

   When used in a notification context, the &lt;keypress&gt; element has
   several attributes that are used to convey details of the event that
   was detected.  It also contains a child element, &lt;status&gt;, that
   provides information on any MSCML request that was in progress when
   the event occurred.  The details of these notification attributes are
   described in the list below.

   Keypress Notification Attributes:

   o  digit - required, no default value: Specifies the DTMF digit
      detected.  Possible values are [0-9], [A-D], '#', or '*'.

   o  length - required, no default value: Specifies the duration class
      of the DTMF input.  Possible values are 'standard' or 'long'.

   o  method - required, no default value: Specifies the keypress
      detection method that generated the notification.  Possible values
      are 'standard', 'long', and 'double'.




<span class="grey">Van Dyke, et al.             Informational                     [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   o  interdigittime - required, no default value: Specifies the elapsed
      time, as a time value (<a href="#section-4.2.1">Section 4.2.1</a>), between the current event
      detection and the previous one.

<span class="h4"><a class="selflink" id="section-7.1.1" href="#section-7.1.1">7.1.1</a>.  Keypress Subscription Examples</span>

   The following examples of MSCML payloads depict a subscription for
   standard keypress events and disabling keypress reporting.

   Figure 21 shows a subscription for standard keypress events.

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;configure_leg&gt;
         &lt;subscribe&gt;
           &lt;events&gt;
             &lt;keypress report="standard"/&gt;
           &lt;/events&gt;
         &lt;/subscribe&gt;
       &lt;/configure_leg&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 21: Standard Digit Events Subscription

   Figure 22 shows a client disabling keypress event notifications.

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;configure_leg&gt;
         &lt;subscribe&gt;
           &lt;events&gt;
             &lt;keypress report="none"/&gt;
           &lt;/events&gt;
         &lt;/subscribe&gt;
       &lt;/configure_leg&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 22: Disabling Keypress Event Reporting

<span class="h4"><a class="selflink" id="section-7.1.2" href="#section-7.1.2">7.1.2</a>.  Keypress Notification Examples</span>

   The following MSCML payloads depict keypress event notifications
   caused by various types of DTMF input.




<span class="grey">Van Dyke, et al.             Informational                     [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   Figure 23 shows a notification generated by the detection of a
   standard "4" DTMF digit.  In this example, this is the first digit
   detected.  Thus, the 'interdigittime' attribute has a value of '0'.

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;notification&gt;
       &lt;keypress digit="4" length="standard" method="standard"
         interdigittime="0"&gt;
         &lt;status command="play" duration="10"/&gt;
       &lt;/keypress&gt;
     &lt;/notification&gt;
   &lt;/MediaServerControl&gt;

   Figure 23: Standard Keypress Notification

   Figure 24 shows a notification generated by detection of a long pound
   (#).

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;notification&gt;
       &lt;keypress digit="#" length="long" method="long"
         interdigittime="200"&gt;
         &lt;status command="idle" duration="4"/&gt;
       &lt;/keypress&gt;
     &lt;/notification&gt;
   &lt;/MediaServerControl&gt;

   Figure 24: Long Keypress Notification

<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>.  Signal Events</span>

   MSCML supports notification of certain call progress tones through
   the &lt;signal&gt; element.  When used in a subscription context, the
   &lt;signal&gt; element has two attributes, 'type' and 'report', and no
   child elements.  These attributes are detailed in the list below.

   Signal Subscription Attributes:

   o  report - required, no default value: Controls whether the
      specified signal is reported.  Possible values are 'yes' and 'no'.
      When set to 'yes', the media server invokes the required signal
      detection code and reports detected events.  When it is set to
      'no', the media server disables the associated signal detection
      code and does not report events.





<span class="grey">Van Dyke, et al.             Informational                     [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   o  type - required, no default value: Specifies the type of call
      progress signal to detect.  Possible values are 'busy', 'ring',
      'CED', 'CNG', and '400', which correspond to busy tone, ring tone,
      fax CED, fax CNG, and 400 Hz tone, respectively.

      NOTE: The details of media server provisioning required to support
      country-specific variants of 'busy' and 'ring' is not covered by
      this specification.

   As stated previously, a single &lt;configure_leg&gt; request MAY contain
   multiple &lt;signal&gt; elements that request notification of different
   call progress tones.  A single &lt;configure_leg&gt; request SHOULD NOT
   contain multiple &lt;signal&gt; elements that have the same 'type'
   attribute value.  If the media server receives such a request, it
   SHOULD honor the last element specifying that type that appears in
   the request.

   The media server generates an immediate response to the
   &lt;configure_leg&gt; subscription request and sends notifications when the
   specified signals are detected.  A single notification is sent as
   soon as the specified signal has been reliably detected.  If the
   signal persists continuously, additional notifications will not be
   sent.  If the signal is interrupted and then resumes, additional
   notifications will be sent.

   Signal notifications have a single attribute, "type", as described in
   the list below.

   Signal Notification Attribute:

   o  type - required, no default value: Specifies the type of call
      progress signal that was detected.  Possible values are 'busy',
      'ring', 'CED', 'CNG', and '400', which correspond to busy tone,
      ring tone, fax CED, fax CNG, and 400 Hz tone, respectively.

<span class="h4"><a class="selflink" id="section-7.2.1" href="#section-7.2.1">7.2.1</a>.  Signal Event Examples</span>

   The following MSCML payloads show a signal event subscription (Figure
   25) and notification (Figure 26).












<span class="grey">Van Dyke, et al.             Informational                     [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;configure_leg&gt;
         &lt;subscribe&gt;
           &lt;events&gt;
             &lt;signal type="busy" report="yes"/&gt;
           &lt;/events&gt;
         &lt;/subscribe&gt;
       &lt;/configure_leg&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 25: Signal Event Subscription

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;notification&gt;
       &lt;signal type="busy"/&gt;
     &lt;/notification&gt;
   &lt;/MediaServerControl&gt;

   Figure 26: Signal Event Notification

<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>.  Managing Content &lt;managecontent&gt;</span>

   MSCML uses the &lt;managecontent&gt; request to move recorded content from
   the media server to remote locations using the HTTP protocol.  This
   is a store-and-forward model, which requires the completion of local
   temporary recording before the media server can send it to the web
   server.  This facility is useful in applications such as voice
   messaging, where a message may be reviewed by the caller prior to
   being committed to persistent storage.

   The &lt;managecontent&gt; request contains no child elements and has the
   attributes described in the list below.

   Managecontent Attributes:

   o  src - required, no default value: Specifies the local source URL
      of the content.  The URL scheme MUST be "file://".

   o  dest - required (see note), no default value: Specifies the
      destination URL.  The URL scheme MUST be "http://".  Note: If the
      selected action is 'delete', this attribute is optional; otherwise
      it is required.





<span class="grey">Van Dyke, et al.             Informational                     [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   o  action - optional, default value "move": Specifies the operation
      for the media server to execute.  Values can be either 'move' or
      'delete'.  The 'delete' action operates on the local source file.
      After a successful move or delete, the media server deletes the
      source file from its local storage.  If the request is
      unsuccessful, the source file is not deleted, which gives the
      client complete control of the retry strategy.

   o  httpmethod - optional, default value "post": HTTP protocol method
      for the media server to use in the HTTP request.  The only values
      are 'post' or 'put'.

   o  name - required (see note), no default value: Specifies the field
      name for the content in the form when using the 'post' method.
      This is not to be confused with the "src" or "dest" attributes.
      Note: This attribute is required when the "htttpmethod" has the
      value "post" and is optional otherwise.

   o  fetchtimeout - optional, default value "10000ms": Specifies the
      maximum time allowed for the transfer to complete.  Expressed as a
      time value (<a href="#section-4.2.1">Section 4.2.1</a>) from 1ms onwards.

   o  mimetype - required (see note), no default value: Specifies the
      MIME type that the media server will use for the content transfer.
      If it is not provided, the media server MUST try to infer it from
      the content file extension based on a platform specific mapping
      table.  A non-normative, example mapping table is shown in Table
      3.  To avoid ambiguity, we RECOMMEND that clients explicitly set
      this attribute.  Note: If the MIME type of the content cannot be
      inferred from the file extension, this attribute is required.

   Table 3 shows common audio and video MIME types and possible file
   extension mappings.


















<span class="grey">Van Dyke, et al.             Informational                     [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


                    +-----------+--------------------+
                    | Extension | MIME Type          |
                    +-----------+--------------------+
                    | alaw      | audio/x-alaw-basic |
                    | ulaw      | audio/basic        |
                    | msgsm     | audio/ms-gsm       |
                    | wav       | audio/x-wav        |
                    | tif       | image/tiff         |
                    | tiff      | image/tiff         |
                    | mov       | video/quicktime    |
                    | qt        | video/quicktime    |
                    | 3gp       | video/3gpp         |
                    | 3gpp      | video/3gpp         |
                    +-----------+--------------------+

           Table 3: Example File Extension to MIME Type Mappings

   &lt;Managecontent&gt; is purely a transport operation; the underlying
   content is not changed by it.  Therefore clients MUST ensure that the
   source and destination file name extensions and MIME types are the
   same.  Failure to do so could result in content that is unreadable.

   The ability to move or delete any local file presents a potential
   risk to the security of the media server system.  For this reason, we
   STRONGLY RECOMMEND that implementers limit local file system access
   when using &lt;managecontent&gt;.  For example, we encourage limiting
   access as based on file ownership and/or specific directories.

<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>.  Managecontent Example</span>

   The following is an example (Figure 27) showing a local file on the
   media server being transferred to an HTTP URL using the "put" method.
   The client sends the following request.

   &lt;?xml version="1.0"?&gt;
   &lt;MediaServerControl version="1.0"&gt;
     &lt;request&gt;
       &lt;managecontent id="102"
       src="file:////var/mediaserver/rec/6A5GH49B.ulaw"
       dest="http://www.example.com/recordings/myrecording.ulaw"
       mimetype="audio/basic" action="move" httpmethod="put"
       fetchtimeout="5000"/&gt;
     &lt;/request&gt;
   &lt;/MediaServerControl&gt;

   Figure 27: Managecontent Example





<span class="grey">Van Dyke, et al.             Informational                     [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   Note that the client can change the temporary file name assigned by
   the media server as part of this operation as shown.

   If the request is ambiguous, the media server MUST return a status
   code of "400" and text "Bad Request."  If the media server is unable
   to execute a syntactically correct and unambiguous request, it MUST
   return a "500" status code with the text "Server Error."  For
   example, the local file system access restrictions may prevent
   deletion of the specified file.  In this case, the "reason" attribute
   in the response conveys additional details on the server error that
   occurred.  If there is a network or remote server error, the media
   server provides detailed error information in the &lt;error_info&gt;
   element contained in the media server response.  Additional
   information regarding &lt;managecontent&gt; responses is provided in
   <a href="#section-10.7">Section 10.7</a>.

<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>.  Fax Processing</span>

<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>.  Recording a Fax &lt;faxrecord&gt;</span>

   The &lt;faxrecord&gt; request directs the media server to process a fax in
   answer mode.  The reason for a request separate from &lt;playrecord&gt; is
   that the media server needs to know to process the T.30 [<a href="#ref-18" title="&quot;Procedures for document facsimile transmission in the general switched telephone network&quot;">18</a>] or T.38
   [<a href="#ref-19" title="&quot;Procedures for real-time Group 3 facsimile communication over IP networks&quot;">19</a>] fax protocols.

   The &lt;faxrecord&gt; request has multiple attributes and one child
   element, &lt;prompt&gt;.  Its attributes are described in the list below.

   Attributes of &lt;faxrecord&gt;:

   o  lclid - optional, default value "" (the empty string): A string
      that identifies the called station.

   o  prompturl - optional, no default value: The URL of the fax content
      to be retrieved and played.  The target may be a local or remote
      (NFS) "file://" scheme URL or an "http://" or "https://" scheme
      URL.  NOTE: Use of this attribute is deprecated.

   o  promptencoding - optional, no default value: Specifies the content
      encoding for files that do not have a 'tif' or 'tiff' extension.
      The only allowable value is 'tiff'.  This attribute only affects
      "file://" scheme URLs.  NOTE: Use of this attribute is deprecated.

   o  recurl - optional, no default value: Specifies the target URL for
      the recorded content.

   o  rmtid - optional, no default value: Specifies the calling station
      identifier of the remote terminal.  If present, the media server



<span class="grey">Van Dyke, et al.             Informational                     [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


      MUST reject transactions with the remote terminal if the remote
      terminal's identifier does not match the value of 'rmtid'.

   Clients SHOULD use the more flexible &lt;prompt&gt; mechanism for
   specifying fax content.  Use of the 'prompturl' attribute is
   deprecated and may not be supported in future MSCML versions.  The
   &lt;prompt&gt; element is described in <a href="#section-6.1.1">Section 6.1.1</a>.  A &lt;prompt&gt; element
   sent in a &lt;faxrecord&gt; request MUST NOT contain &lt;variable&gt; elements.

   Media servers MUST support local and remote (NFS) "file://" scheme
   URLs in the "recurl" attribute.  MSCML supports "http://" and
   "https://" scheme URLs indirectly through the &lt;managecontent&gt;
   (<a href="#section-8">Section 8</a>) request.

   The &lt;faxrecord&gt; request operates in one of three modes: receive,
   poll, and turnaround poll.  The combination of &lt;prompt&gt; or
   'prompturl' attribute and 'recurl' attribute define the mode.  Table
   4 describes these modes in detail.  The 'prompt' column in the table
   has the value 'yes' if the request has either a &lt;prompt&gt; element or a
   'prompturl' attribute.

   +--------+--------+---------+---------------------------------------+
   | prompt | recurl | Mode    | Operation                             |
   +--------+--------+---------+---------------------------------------+
   | no     | no     | Invalid | Request fails.                        |
   | no     | yes    | Receive | Record the fax to the target URL      |
   |        |        |         | specified in 'recurl'.                |
   | yes    | no     | Poll    | Send fax from source specified in the |
   |        |        |         | &lt;prompt&gt; element or 'prompturl'       |
   |        |        |         | attribute.  If there is a 'rmtid', it |
   |        |        |         | MUST match the remote terminal's      |
   |        |        |         | identifier, or the request will fail. |
   | yes    | yes    | TP      | Turnaround Poll (TP) mode. If the     |
   |        |        |         | remote terminal wishes to transmit,   |
   |        |        |         | the media server records the fax to   |
   |        |        |         | the target URL specified in 'recurl'. |
   |        |        |         | If the remote terminal wishes to      |
   |        |        |         | receive, the media server sends the   |
   |        |        |         | fax from the source URL contained in  |
   |        |        |         | &lt;prompt&gt; or 'prompturl'.  If there is |
   |        |        |         | a 'rmtid', it MUST match remote       |
   |        |        |         | terminal's identifier, or the send    |
   |        |        |         | request will fail.  A receive         |
   |        |        |         | operation will still succeed,         |
   |        |        |         | however.                              |
   +--------+--------+---------+---------------------------------------+

                        Table 4: Fax Receive Modes



<span class="grey">Van Dyke, et al.             Informational                     [Page 52]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   In receive mode, the media server receives the fax and writes the fax
   data to the target URL specified by the 'recurl' attribute.

   In poll mode, the media server sends a fax, but as a polled (called)
   device.

   In turnaround poll mode, the media server will record a fax that the
   remote machine sends.  If the remote machine requests a transmission,
   then the media server will send the fax.

   When transmitting a fax, the media server will advertise that it can
   receive faxes in the DIS message.  Likewise, when receiving a fax,
   the media server will advertise that it can send faxes in the DIS
   message.

   The media server MUST flush any quarantined digits when it receives a
   &lt;faxrecord&gt; request.

<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>.  Sending a Fax &lt;faxplay&gt;</span>

   The &lt;faxplay&gt; request directs the media server to process a fax in
   originate mode.  The reason for a request separate from &lt;play&gt; is
   that the media server needs to know to process the T.30 [<a href="#ref-18" title="&quot;Procedures for document facsimile transmission in the general switched telephone network&quot;">18</a>] or T.38
   [<a href="#ref-19" title="&quot;Procedures for real-time Group 3 facsimile communication over IP networks&quot;">19</a>] fax protocols.

   The &lt;faxplay&gt; request has multiple attributes and one child element,
   &lt;prompt&gt;.  Its attributes are described in the list below.

   Attributes of &lt;faxplay&gt;:

   o  lclid - optional, default value "" (the empty string): A string
      that identifies the called station.

   o  prompturl - optional, no default value: The URL of the content to
      be retrieved and played.  The target may be a local or remote
      (NFS) "file://" scheme URL or an "http://" or "https://" scheme
      URL.  NOTE: Use of this attribute is deprecated.

   o  promptencoding - optional, no default value: Specifies the content
      encoding for files that do not have a 'tif' or 'tiff' extension.
      The only allowable value is 'tiff'.  This attribute only affects
      "file://" scheme URLs.  NOTE: Use of this attribute is deprecated.

   o  recurl - optional, no default value: Specifies the target URL for
      the recorded content.

   o  rmtid - optional, no default value: Specifies the calling station
      identifier of the remote terminal.  If present, the media server



<span class="grey">Van Dyke, et al.             Informational                     [Page 53]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


      MUST reject transactions with the remote terminal if the remote
      terminal's identifier does not match the value of 'rmtid'.

   Clients SHOULD use the more flexible &lt;prompt&gt; mechanism for
   specifying fax content.  Use of the 'prompturl' attribute is
   deprecated and may not be supported in future MSCML versions.  The
   &lt;prompt&gt; element is described in <a href="#section-6.1.1">Section 6.1.1</a>.  A &lt;prompt&gt; element
   sent in a &lt;faxrecord&gt; request MUST NOT contain &lt;variable&gt; elements.

   Media servers MUST support local and remote (NFS) "file://" scheme
   URLs in the "recurl" attribute.  MSCML supports "http://" and
   "https://" scheme URLs indirectly through the &lt;managecontent&gt;
   (<a href="#section-8">Section 8</a>) request.

   The &lt;faxplay&gt; request operates in one of three modes: send, remote
   poll, and turnaround poll.  The combination of &lt;prompt&gt; or
   'prompturl' attribute and 'recurl' attribute define the mode.  Table
   5 describes these modes in detail.  The 'prompt' column in the table
   has the value 'yes' if the request has either a &lt;prompt&gt; element or a
   'prompturl' attribute.































<span class="grey">Van Dyke, et al.             Informational                     [Page 54]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   +--------+--------+---------+---------------------------------------+
   | prompt | recurl | Mode    | Operation                             |
   +--------+--------+---------+---------------------------------------+
   | no     | no     | Invalid | Request fails.                        |
   | yes    | no     | Send    | Send fax from source specified in the |
   |        |        |         | &lt;prompt&gt; element or 'prompturl'       |
   |        |        |         | attribute. If there is a 'rmtid', it  |
   |        |        |         | MUST match the remote terminal's      |
   |        |        |         | identifier, or the request will fail. |
   | no     | yes    | Poll    | Send fax from source specified in the |
   |        |        |         | &lt;prompt&gt; element or 'prompturl'       |
   |        |        |         | attribute, assuming the remote        |
   |        |        |         | terminal specifies it can receive a   |
   |        |        |         | fax in its DIS message. If the remote |
   |        |        |         | terminal does not support reverse     |
   |        |        |         | polling, the request will fail. If    |
   |        |        |         | 'rmtid' is specified, it MUST match   |
   |        |        |         | remote terminal's identifier, or the  |
   |        |        |         | request will fail.                    |
   | yes    | yes    | TP      | Turnaround Poll (TP) mode. If the     |
   |        |        |         | remote terminal wishes to transmit,   |
   |        |        |         | the media server records the fax to   |
   |        |        |         | the target URL specified in 'recurl'. |
   |        |        |         | If the remote terminal wishes to      |
   |        |        |         | receive, the media server sends the   |
   |        |        |         | fax from the source URL contained in  |
   |        |        |         | &lt;prompt&gt; or 'prompturl'. If there is  |
   |        |        |         | a 'rmtid', it MUST match remote       |
   |        |        |         | terminal's identifier, or the send    |
   |        |        |         | request will fail. A receive          |
   |        |        |         | operation will still succeed,         |
   |        |        |         | however.                              |
   +--------+--------+---------+---------------------------------------+

                          Table 5: Fax Send Modes

   In send mode, the media server sends the fax.

   In remote poll mode, the client places a call on behalf of the media
   server.  The media server requests a fax transmission from the remote
   fax terminal.

   In turnaround poll mode, the media server will record a fax that the
   remote machine sends.  If the remote machine requests a transmission,
   then the media server will send the fax.

   When transmitting a fax, the media server will advertise that it can
   receive faxes in the DIS message.  Likewise, when receiving a fax,



<span class="grey">Van Dyke, et al.             Informational                     [Page 55]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   the media server will advertise that it can send faxes in the DIS
   message.

   The media server MUST flush any quarantined digits when it receives a
   &lt;faxplay&gt; request.

<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>.  MSCML Response Attributes and Elements</span>

<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>.  Mechanism</span>

   The media server acknowledges receipt of a client MSCML request sent
   in a SIP INVITE by sending a response of either 200 OK or 415 Bad
   Media Type.  The media server responds with 415 when the SIP request
   contains a content type other than "application/sdp" or "application/
   mediaservercontrol+xml".

   The media server acknowledges receipt of a client MSCML request sent
   in a SIP INFO with a 200 OK or 415 Bad Media Type.  The media server
   responds with 415 if the INFO request contains a content type other
   than "application/mediaservercontrol+xml".

   The media server transports the MSCML &lt;response&gt; message in a SIP
   INFO request.

   If there is an error in the request or the media server cannot
   complete the request, the media server sends the &lt;response&gt; message
   very shortly after receiving the request.  If the request is able to
   proceed, the &lt;response&gt; contains final status information as
   described below.

<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>.  Base &lt;response&gt; Attributes</span>

   All MSCML responses have the basic attributes defined in the list
   below.

   Basic MSCML Response Attributes:

   o  id - optional, no default value: Echoes the client-defined ID
      contained in the request.

   o  request - required, no default value: Specifies the MSCML request
      type that generated the response.  Allowable values are
      "configure_conference", "configure_leg", "play", "playcollect",
      "playrecord", "stop", "faxplay", "faxrecord", and "managecontent".







<span class="grey">Van Dyke, et al.             Informational                     [Page 56]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   o  code - required, no default value: The final status code for the
      request.  MSCML uses a subset of the status classes defined in <a href="./rfc3261">RFC</a>
      <a href="./rfc3261">3261</a> [<a href="#ref-4" title="&quot;SIP: Session Initiation Protocol&quot;">4</a>].  In MSCML, 2XX responses indicate success, 4XX responses
      indicate client error, and 5XX responses indicate an error on the
      media server.  There are no 1XX, 3XX, or 6XX status codes in
      MSCML.

   o  text - required, no default value: The human readable reason
      phrase associated with the status code.

   Responses to &lt;configure_conference&gt; and &lt;stop&gt; requests contain only
   the attributes above.  MSCML responses to other requests MAY contain
   additional request-specific attributes and elements.  These are
   described in the following sections.

<span class="h3"><a class="selflink" id="section-10.3" href="#section-10.3">10.3</a>.  Response Attributes and Elements for &lt;configure_leg&gt;</span>

   Responses to &lt;configure_leg&gt; requests have only the base response
   attributes defined in <a href="#section-10.2">Section 10.2</a>.  However, when the request
   contains a &lt;configure_team&gt; element, the response includes a &lt;team&gt;
   element describing the teammate configuration for that leg.  The
   attributes of the &lt;team&gt; element are shown in the list below.

   Attributes of &lt;team&gt;:

   o  id - required, no default value: The client-defined unique
      identifier for the conference leg.

   o  numteam - required, no default value: The number of team members
      for the leg.

   Additional information on each team member is conveyed by child
   &lt;teammate&gt; elements contained within &lt;team&gt;.  Each teammate is
   represented by a single element in the list.  The &lt;teammate&gt; element
   has a single attribute, as described below.

   Attributes of &lt;teammate&gt;:

   o  id - required, no default value: The client-defined unique
      identifier for the teammate leg.

<span class="h3"><a class="selflink" id="section-10.4" href="#section-10.4">10.4</a>.  Response Attributes and Elements for &lt;play&gt;</span>

   In addition to the base response attributes defined in <a href="#section-10.2">Section 10.2</a>,
   responses to &lt;play&gt; requests have the additional attributes described
   in the list below.





<span class="grey">Van Dyke, et al.             Informational                     [Page 57]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   MSCML Response Attributes for &lt;play&gt;:

   o  reason - optional, no default value: For requests that are not
      completed immediately, the "reason" attribute conveys additional
      information regarding why the command was completed.  Possible
      values are "stopped", indicating that an explicit or implicit
      &lt;stop&gt; request was received, and "EOF", indicating that the end of
      the specified sequence of URLs was reached.

   o  playduration - required, no default value: A time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) that returns the duration of the associated content
      playout.

   o  playoffset - required, no default value: A time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) that returns the time offset into the specified content
      sequence where play was terminated.  If the initial "offset" value
      in the sequence was "0", then "playduration" and "playoffset" are
      equal.  However, if the initial offset had some other value,
      "playoffset" serves as a bookmark for the client to resume play in
      a subsequent request.

<span class="h4"><a class="selflink" id="section-10.4.1" href="#section-10.4.1">10.4.1</a>.  Reporting Content Retrieval Errors</span>

   If the associated request set "stoponerror=yes" in &lt;prompt&gt; and an
   error occurred while retrieving the specified content the response
   will include an &lt;error_info&gt; element detailing the problem.  This
   element contains the response information received from the remote
   content server.  The &lt;error_info&gt; element has the attributes
   described in the list below.

   Attributes of &lt;error_info&gt;:

   o  code - required, no default value: The status code returned by the
      remote content server.  For example, a web server might return 404
      to indicate that the requested content was not found.

   o  text - required, no default value: The human-readable reason
      phrase returned by the remote content server.  For example, the
      reason phrase "Not Found" would be returned if the requested
      content was not found.

   o  context - required, no default value: Contains the content URL
      that was being fetched when the retrieval error occurred.  This
      enables the client to know precisely which URL in a sequence
      caused the problem.

   An &lt;error_info&gt; element MAY be present in the response to any request
   that contains a child &lt;prompt&gt; element.



<span class="grey">Van Dyke, et al.             Informational                     [Page 58]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h3"><a class="selflink" id="section-10.5" href="#section-10.5">10.5</a>.  Response Attributes and Elements for &lt;playcollect&gt;</span>

   In addition to the base response attributes defined in <a href="#section-10.2">Section 10.2</a>,
   responses to &lt;playcollect&gt; requests have the additional attributes
   described in the list below.

   MSCML Response Attributes for &lt;playcollect&gt;:

   o  reason - optional, no default value: For requests that are not
      completed immediately, the "reason" attribute conveys additional
      information regarding why the command was completed.  Possible
      values are "stopped", indicating that an explicit or implicit
      &lt;stop&gt; request was received; "match", meaning that a DTMF grammar
      was matched; "timeout", indicating that no DTMF input was received
      before one of the collection timers expired; and "returnkey" or
      "escapekey", meaning the DTMF digit mapped to that key was
      detected and the return key or escape key terminated the
      operation, respectively.

   o  playduration - required, no default value: A time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) that returns the duration of the associated content
      playout.  If the caller barged the prompt, this value will reflect
      the play duration up to that event.

   o  playoffset - required, no default value: A time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) that returns the time offset into the specified content
      sequence where play was terminated.  If the initial "offset" value
      in the sequence was "0", then "playduration" and "playoffset" are
      equal.  However, if the initial offset had some other value,
      "playoffset" serves as a bookmark for the client to resume play in
      a subsequent request.  If the caller barged the prompt this value
      will reflect the time offset at which barge-in occurred.

   o  digits - required, no default value: Contains the collected DTMF
      input characters.  If no DTMF input was collected, this attribute
      is set to the empty string ("").

   o  name - required (see note), no default value: The client-defined
      name of the DTMF grammar that was matched.  Note: This attribute
      is required if the "name" attribute was set in the matching DTMF
      grammar.

   Responses to &lt;playcollect&gt; requests MAY include an &lt;error_info&gt;
   element, as described in <a href="#section-10.4.1">Section 10.4.1</a>.







<span class="grey">Van Dyke, et al.             Informational                     [Page 59]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h3"><a class="selflink" id="section-10.6" href="#section-10.6">10.6</a>.  Response Attributes and Elements for &lt;playrecord&gt;</span>

   In addition to the base response attributes defined in <a href="#section-10.2">Section 10.2</a>,
   responses to &lt;playrecord&gt; requests have the additional attributes
   described in the list below.

   o  reason - optional, no default value: For requests that are not
      completed immediately, the "reason" attribute conveys additional
      information regarding why the command was completed.  Possible
      values are "stopped", indicating that an explicit or implicit
      &lt;stop&gt; request was received; "digit", meaning that a DTMF digit
      was detected and that the prompt phase was barged; "init_silence",
      meaning the recording terminated because of no input;
      "end_silence", meaning that the recording was terminated because
      the "endsilence" timer elapsed; "max_duration", indicating that
      the maximum time for the recording was reached; "escapekey",
      indicating that the DTMF input mapped to "escapekey" was detected,
      thus terminating the recording; and "error", indicating a general
      operation failure.

   o  playduration - required, no default value: A time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) that returns the duration of the associated content
      playout.  If the caller barged the prompt, this value will reflect
      the play duration up to that event.

   o  playoffset - required, no default value: A time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) that returns the time offset into the specified content
      sequence where play was terminated.  If the initial "offset" value
      in the sequence was "0", then "playduration" and "playoffset" are
      equal.  However, if the initial offset had some other value,
      "playoffset" serves as a bookmark for the client to resume play in
      a subsequent request.  If the caller barged the prompt this value
      will reflect the time offset at which barge-in occurred.

   o  digits - required, no default value: Contains the DTMF digit that
      terminated the recording.  If no DTMF input was detected, this
      attribute is set to the empty string ("").

   o  reclength - required, no default value: The length of the recorded
      content, in bytes.

   o  recduration - required, no default value: A time value (<a href="#section-4.2.1">Section</a>
      <a href="#section-4.2.1">4.2.1</a>) indicating the elapsed duration of the recording.

   Responses to &lt;playrecord&gt; requests MAY include an &lt;error_info&gt;
   element, as described in <a href="#section-10.4.1">Section 10.4.1</a>.





<span class="grey">Van Dyke, et al.             Informational                     [Page 60]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h3"><a class="selflink" id="section-10.7" href="#section-10.7">10.7</a>.  Response Attributes and Elements for &lt;managecontent&gt;</span>

   Responses to &lt;managecontent&gt; requests have only the base response
   attributes defined in <a href="#section-10.2">Section 10.2</a>.  If a content transfer error
   occurs while executing the request the response will also contain an
   &lt;error_info&gt; element as described in <a href="#section-10.4.1">Section 10.4.1</a>.

<span class="h3"><a class="selflink" id="section-10.8" href="#section-10.8">10.8</a>.  Response Attributes and Elements for &lt;faxplay&gt; and &lt;faxrecord&gt;</span>

   In addition to the base response attributes defined in <a href="#section-10.2">Section 10.2</a>,
   responses to &lt;faxplay&gt; and &lt;faxrecord&gt; requests have the additional
   attributes described in the list below.

   o  reason - required, no default value: For requests that are not
      completed immediately, the "reason" attribute conveys additional
      information regarding why the command was completed.  Possible
      values are "stopped", indicating that an explicit or implicit
      &lt;stop&gt; request was received; "complete", indicating successful
      completion, even if there were bad lines or minor negotiation
      problems (e.g., a DCN was received); "disconnect", meaning that
      the session was disconnected; and "notfax", indicating that no DIS
      or DCS was received on the connection.

   o  pages_received - required (see note), no default value: Indicates
      the number of fax pages received.  Note: This attribute is
      required if any pages were received.

   o  pages_sent - required (see note), no default value: Indicates the
      number of fax pages sent.  Note: This attribute is required if any
      pages were sent.

   o  faxcode - required, no default value: The value of the "faxcode"
      attribute is the binary-or of the bit patterns defined in Table 6.


















<span class="grey">Van Dyke, et al.             Informational                     [Page 61]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


              +------+--------------------------------------+
              | Mask | description                          |
              +------+--------------------------------------+
              | 0    | Operation Failed                     |
              | 1    | Operation Succeeded                  |
              | 2    | Partial Success                      |
              | 4    | Image received and placed in recurl  |
              | 8    | Image sent from specified source URL |
              | 16   | rmtid did not match                  |
              | 32   | Error reading source URL             |
              | 64   | Error writing recurl                 |
              | 128  | Negotiation failure on send phase    |
              | 256  | Negotiation failure on receive phase |
              | 512  | Reserved                             |
              | 1024 | Irrecoverable IP packet loss         |
              | 2048 | Line errors in received image        |
              +------+--------------------------------------+

                           Table 6: Faxcode Mask

   Responses to &lt;faxplay&gt; and &lt;faxrecord&gt; requests MAY include an
   &lt;error_info&gt; element, as described in <a href="#section-10.4.1">Section 10.4.1</a>.

<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>.  Formal Syntax</span>

   The following syntax specification uses XML Schema as described in
   XML [<a href="#ref-7" title="&quot;XML Schema Part 1: Structures&quot;">7</a>].

<span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.1</a>.  Schema</span>

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
     elementFormDefault="qualified"&gt;
     &lt;xs:element name="MediaServerControl"&gt;
       &lt;xs:complexType&gt;
         &lt;xs:choice&gt;
           &lt;xs:element name="request"&gt;
             &lt;xs:complexType&gt;
               &lt;xs:choice&gt;
                 &lt;xs:element name="configure_conference"
                   type="configure_conferenceRequestType"/&gt;
                 &lt;xs:element name="configure_leg"
                   type="configure_legRequestType"/&gt;
                 &lt;xs:element name="play" type="playRequestType"/&gt;
                 &lt;xs:element name="playcollect"
                   type="playcollectRequestType"/&gt;
                 &lt;xs:element name="playrecord"
                   type="playrecordRequestType"/&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 62]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


                 &lt;xs:element name="managecontent"
                   type="managecontentRequestType"/&gt;
                 &lt;xs:element name="faxplay"
                   type="faxRequestType"/&gt;
                 &lt;xs:element name="faxrecord"
                   type="faxRequestType"/&gt;
                 &lt;xs:element name="stop" type="stopRequestType"/&gt;
               &lt;/xs:choice&gt;
             &lt;/xs:complexType&gt;
           &lt;/xs:element&gt;
           &lt;xs:element name="response" type="responseType"/&gt;
           &lt;xs:element name="notification"&gt;
             &lt;xs:complexType&gt;
               &lt;xs:choice&gt;
                 &lt;xs:element name="conference"
                   type="conferenceNotificationType"/&gt;
                 &lt;xs:element name="keypress"
                   type="keypressNotificationType"/&gt;
                 &lt;xs:element name="signal"
                   type="signalNotificationType"/&gt;
               &lt;/xs:choice&gt;
             &lt;/xs:complexType&gt;
           &lt;/xs:element&gt;
         &lt;/xs:choice&gt;
         &lt;xs:attribute name="version" use="required"/&gt;
       &lt;/xs:complexType&gt;
     &lt;/xs:element&gt;
     &lt;!-- Definitions for base and concrete MSCML requests --&gt;
     &lt;!-- and embedded types. --&gt;
     &lt;xs:complexType name="base_requestType" abstract="true"&gt;
       &lt;xs:attribute name="id" type="xs:string"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="playRequestType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_requestType"&gt;
           &lt;xs:sequence&gt;
             &lt;xs:element name="prompt" type="promptType"
               minOccurs="0"/&gt;
           &lt;/xs:sequence&gt;
           &lt;xs:attribute name="prompturl" type="xs:string"/&gt;
           &lt;xs:attribute name="offset" type="xs:string"/&gt;
           &lt;xs:attribute name="promptencoding" type="xs:string"/&gt;
         &lt;/xs:extension&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="configure_conferenceRequestType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_requestType"&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 63]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


           &lt;xs:sequence&gt;
             &lt;xs:element name="subscribe"
               type="conference_eventsubscriptionType" minOccurs="0"/&gt;
           &lt;/xs:sequence&gt;
           &lt;xs:attribute name="reservedtalkers"
             type="xs:positiveInteger"/&gt;
           &lt;xs:attribute name="reserveconfmedia" type="yesnoType"
             default="yes"/&gt;
         &lt;/xs:extension&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="configure_legRequestType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_requestType"&gt;
           &lt;xs:sequence&gt;
             &lt;xs:element name="inputgain" type="gainType"
               minOccurs="0"/&gt;
             &lt;xs:element name="outputgain" type="gainType"
               minOccurs="0"/&gt;
             &lt;xs:element name="configure_team"
               type="configure_teamType" minOccurs="0"/&gt;
             &lt;xs:element name="subscribe"
               type="leg_eventsubscriptionType" minOccurs="0"/&gt;
           &lt;/xs:sequence&gt;
           &lt;xs:attribute name="type"&gt;
             &lt;xs:simpleType&gt;
               &lt;xs:restriction base="xs:NMTOKEN"&gt;
                 &lt;xs:enumeration value="talker"/&gt;
                 &lt;xs:enumeration value="listener"/&gt;
               &lt;/xs:restriction&gt;
             &lt;/xs:simpleType&gt;
           &lt;/xs:attribute&gt;
           &lt;xs:attribute name="mixmode"&gt;
             &lt;xs:simpleType&gt;
               &lt;xs:restriction base="xs:NMTOKEN"&gt;
                 &lt;xs:enumeration value="full"/&gt;
                 &lt;xs:enumeration value="mute"/&gt;
                 &lt;xs:enumeration value="preferred"/&gt;
                 &lt;xs:enumeration value="parked"/&gt;
                 &lt;xs:enumeration value="private"/&gt;
               &lt;/xs:restriction&gt;
             &lt;/xs:simpleType&gt;
           &lt;/xs:attribute&gt;
           &lt;xs:attribute name="dtmfclamp" type="yesnoType"/&gt;
           &lt;xs:attribute name="toneclamp" type="yesnoType"/&gt;
         &lt;/xs:extension&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 64]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


     &lt;xs:complexType name="configure_teamType"&gt;
       &lt;xs:sequence&gt;
         &lt;xs:element name="teammate" type="teammateType" minOccurs="0"
           maxOccurs="unbounded"/&gt;
       &lt;/xs:sequence&gt;
       &lt;xs:attribute name="id" type="xs:string"/&gt;
       &lt;xs:attribute name="action" use="required"&gt;
         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:string"&gt;
             &lt;xs:enumeration value="add"/&gt;
             &lt;xs:enumeration value="delete"/&gt;
             &lt;xs:enumeration value="query"/&gt;
             &lt;xs:enumeration value="set"/&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;
       &lt;/xs:attribute&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="teammateType"&gt;
       &lt;xs:attribute name="id" type="xs:string" use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="playcollectRequestType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_requestType"&gt;
           &lt;xs:sequence&gt;
             &lt;xs:element name="prompt" type="promptType"
               minOccurs="0"/&gt;
             &lt;xs:element name="pattern" type="dtmfGrammarType"
               minOccurs="0"/&gt;
           &lt;/xs:sequence&gt;
           &lt;xs:attribute name="prompturl" type="xs:string"/&gt;
           &lt;xs:attribute name="offset" type="xs:string"/&gt;
           &lt;xs:attribute name="barge" type="yesnoType" default="yes"/&gt;
           &lt;xs:attribute name="promptencoding" type="xs:string"/&gt;
           &lt;xs:attribute name="cleardigits" type="yesnoType"
             default="no"/&gt;
           &lt;xs:attribute name="maxdigits" type="xs:string"/&gt;
           &lt;xs:attribute name="firstdigittimer" type="xs:string"
             default="5000ms"/&gt;
           &lt;xs:attribute name="interdigittimer" type="xs:string"
             default="2000ms"/&gt;
           &lt;xs:attribute name="extradigittimer" type="xs:string"
             default="1000ms"/&gt;
           &lt;xs:attribute name="interdigitcriticaltimer"
             type="xs:string"/&gt;
           &lt;xs:attribute name="skipinterval" type="xs:string"
             default="6s"/&gt;
           &lt;xs:attribute name="ffkey" type="DTMFkeyType"/&gt;
           &lt;xs:attribute name="rwkey" type="DTMFkeyType"/&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 65]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


           &lt;xs:attribute name="returnkey" type="DTMFkeyType"
             default="#"/&gt;
           &lt;xs:attribute name="escapekey" type="DTMFkeyType"
             default="*"/&gt;
           &lt;xs:attribute name="maskdigits" type="yesnoType"
             default="no"/&gt;
         &lt;/xs:extension&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="playrecordRequestType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_requestType"&gt;
           &lt;xs:sequence&gt;
             &lt;xs:element name="prompt" type="promptType"
               minOccurs="0"/&gt;
           &lt;/xs:sequence&gt;
           &lt;xs:attribute name="prompturl" type="xs:string"/&gt;
           &lt;xs:attribute name="promptencoding" type="xs:string"/&gt;
           &lt;xs:attribute name="offset" type="xs:string" default="0"/&gt;
           &lt;xs:attribute name="barge" type="yesnoType" default="yes"/&gt;
           &lt;xs:attribute name="cleardigits" type="yesnoType"
             default="no"/&gt;
           &lt;xs:attribute name="escapekey" type="xs:string" default="*"/&gt;
           &lt;xs:attribute name="recurl" type="xs:string" use="required"/&gt;
           &lt;xs:attribute name="mode" default="overwrite"&gt;
             &lt;xs:simpleType&gt;
               &lt;xs:restriction base="xs:NMTOKEN"&gt;
                 &lt;xs:enumeration value="append"/&gt;
                 &lt;xs:enumeration value="overwrite"/&gt;
               &lt;/xs:restriction&gt;
             &lt;/xs:simpleType&gt;
           &lt;/xs:attribute&gt;
           &lt;xs:attribute name="recencoding" type="xs:string"/&gt;
           &lt;xs:attribute name="initsilence" type="xs:string"/&gt;
           &lt;xs:attribute name="endsilence" type="xs:string"/&gt;
           &lt;xs:attribute name="duration" type="xs:string"/&gt;
           &lt;xs:attribute name="beep" type="yesnoType" default="yes"/&gt;
           &lt;xs:attribute name="recstopmask" type="xs:string"
             default="01234567890*#"/&gt;
         &lt;/xs:extension&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="managecontentRequestType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_requestType"&gt;
           &lt;xs:attribute name="fetchtimeout" type="xs:string"
             default="10000"/&gt;
           &lt;xs:attribute name="mimetype" type="xs:string"/&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 66]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


           &lt;xs:attribute name="name" type="xs:string"/&gt;
           &lt;xs:attribute name="httpmethod"&gt;
             &lt;xs:simpleType&gt;
               &lt;xs:restriction base="xs:NMTOKEN"&gt;
                 &lt;xs:enumeration value="put"/&gt;
                 &lt;xs:enumeration value="post"/&gt;
               &lt;/xs:restriction&gt;
             &lt;/xs:simpleType&gt;
           &lt;/xs:attribute&gt;
           &lt;xs:attribute name="action"&gt;
             &lt;xs:simpleType&gt;
               &lt;xs:restriction base="xs:NMTOKEN"&gt;
                 &lt;xs:enumeration value="move"/&gt;
                 &lt;xs:enumeration value="delete"/&gt;
               &lt;/xs:restriction&gt;
             &lt;/xs:simpleType&gt;
           &lt;/xs:attribute&gt;
           &lt;xs:attribute name="dest" type="xs:string"/&gt;
           &lt;xs:attribute name="src" type="xs:string" use="required"/&gt;
         &lt;/xs:extension&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="stopRequestType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_requestType"/&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="faxRequestType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_requestType"&gt;
           &lt;xs:sequence&gt;
             &lt;xs:element name="prompt" type="promptType" minOccurs="0"/&gt;
           &lt;/xs:sequence&gt;
           &lt;xs:attribute name="lclid" type="xs:string"/&gt;
           &lt;xs:attribute name="prompturl" type="xs:string"/&gt;
           &lt;xs:attribute name="recurl" type="xs:string"/&gt;
           &lt;xs:attribute name="rmtid" type="xs:string"/&gt;
         &lt;/xs:extension&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="dtmfGrammarType"&gt;
       &lt;xs:choice&gt;
         &lt;xs:element name="regex" type="dtmfPatternType"
           maxOccurs="unbounded"/&gt;
         &lt;xs:element name="mgcpdigitmap" type="dtmfPatternType"/&gt;
         &lt;xs:element name="megacodigitmap" type="dtmfPatternType"/&gt;
       &lt;/xs:choice&gt;
     &lt;/xs:complexType&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 67]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


     &lt;xs:complexType name="dtmfPatternType"&gt;
       &lt;xs:attribute name="value" type="xs:string" use="required"/&gt;
       &lt;xs:attribute name="name" type="xs:string"/&gt;
     &lt;/xs:complexType&gt;
     &lt;!-- Definitions for base and concrete MSCML responses --&gt;
     &lt;!-- and embedded types. --&gt;
     &lt;xs:complexType name="base_responseType" abstract="true"&gt;
       &lt;xs:attribute name="request" use="required"&gt;
         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:NMTOKEN"&gt;
             &lt;xs:enumeration value="configure_conference"/&gt;
             &lt;xs:enumeration value="configure_leg"/&gt;
             &lt;xs:enumeration value="play"/&gt;
             &lt;xs:enumeration value="playcollect"/&gt;
             &lt;xs:enumeration value="playrecord"/&gt;
             &lt;xs:enumeration value="managecontent"/&gt;
             &lt;xs:enumeration value="faxplay"/&gt;
             &lt;xs:enumeration value="faxrecord"/&gt;
             &lt;xs:enumeration value="stop"/&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;
       &lt;/xs:attribute&gt;
       &lt;xs:attribute name="id" type="xs:string"/&gt;
       &lt;xs:attribute name="code" type="xs:string" use="required"/&gt;
       &lt;xs:attribute name="text" type="xs:string" use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="responseType"&gt;
       &lt;xs:complexContent&gt;
         &lt;xs:extension base="base_responseType"&gt;
           &lt;xs:sequence&gt;
             &lt;xs:element name="error_info"
               type="stoponerrorResponseType" minOccurs="0"/&gt;
             &lt;xs:element name="team" type="configure_teamResponseType"
               minOccurs="0"/&gt;
           &lt;/xs:sequence&gt;
           &lt;xs:attribute name="reason" type="xs:string"/&gt;
           &lt;xs:attribute name="reclength" type="xs:string"/&gt;
           &lt;xs:attribute name="recduration" type="xs:string"/&gt;
           &lt;xs:attribute name="digits" type="xs:string"/&gt;
           &lt;xs:attribute name="name" type="xs:string"/&gt;
           &lt;xs:attribute name="playduration" type="xs:string"/&gt;
           &lt;xs:attribute name="playoffset" type="xs:string"/&gt;
           &lt;xs:attribute name="faxcode" type="xs:string"/&gt;
           &lt;xs:attribute name="pages_sent" type="xs:string"/&gt;
           &lt;xs:attribute name="pages_recv" type="xs:string"/&gt;
         &lt;/xs:extension&gt;
       &lt;/xs:complexContent&gt;
     &lt;/xs:complexType&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 68]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


     &lt;xs:complexType name="stoponerrorResponseType"&gt;
       &lt;xs:attribute name="code" type="xs:string" use="required"/&gt;
       &lt;xs:attribute name="text" type="xs:string" use="required"/&gt;
       &lt;xs:attribute name="context" type="xs:string" use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="configure_teamResponseType"&gt;
       &lt;xs:sequence&gt;
         &lt;xs:element name="teammate" type="teammateType" minOccurs="0"
           maxOccurs="unbounded"/&gt;
       &lt;/xs:sequence&gt;
       &lt;xs:attribute name="id" type="xs:string" use="required"/&gt;
       &lt;xs:attribute name="numteam" type="xs:integer" use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;!-- Definitions for MSCML event subscriptions and --&gt;
     &lt;!-- embedded types --&gt;
     &lt;xs:complexType name="conference_eventsubscriptionType"&gt;
       &lt;xs:sequence&gt;
         &lt;xs:element name="events"&gt;
           &lt;xs:complexType&gt;
             &lt;xs:sequence&gt;
               &lt;xs:element name="activetalkers"
                 type="activetalkersSubscriptionType"/&gt;
             &lt;/xs:sequence&gt;
           &lt;/xs:complexType&gt;
         &lt;/xs:element&gt;
       &lt;/xs:sequence&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="activetalkersSubscriptionType"&gt;
       &lt;xs:attribute name="report" type="yesnoType" use="required"/&gt;
       &lt;xs:attribute name="interval" type="xs:string" default="60s"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="leg_eventsubscriptionType"&gt;
       &lt;xs:sequence&gt;
         &lt;xs:element name="events"&gt;
           &lt;xs:complexType&gt;
             &lt;xs:sequence&gt;
               &lt;xs:element name="keypress"
                 type="keypressSubscriptionType" minOccurs="0"
                   maxOccurs="1"/&gt;
               &lt;xs:element name="signal" type="signalSubscriptionType"
                 minOccurs="0" maxOccurs="unbounded"/&gt;
             &lt;/xs:sequence&gt;
           &lt;/xs:complexType&gt;
         &lt;/xs:element&gt;
       &lt;/xs:sequence&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="keypressSubscriptionType"&gt;
       &lt;xs:attribute name="report" use="required"&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 69]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:NMTOKEN"&gt;
             &lt;xs:enumeration value="standard"/&gt;
             &lt;xs:enumeration value="long"/&gt;
             &lt;xs:enumeration value="both"/&gt;
             &lt;xs:enumeration value="none"/&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;
       &lt;/xs:attribute&gt;
       &lt;xs:attribute name="maskdigits" type="yesnoType" default="no"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="signalSubscriptionType"&gt;
       &lt;xs:attribute name="type" type="xs:NMTOKEN" use="required"/&gt;
       &lt;xs:attribute name="report" type="yesnoType" use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;!-- Definitions for MSCML event notifications and --&gt;
     &lt;!-- embedded types. --&gt;
     &lt;xs:complexType name="conferenceNotificationType"&gt;
       &lt;xs:sequence&gt;
         &lt;xs:element name="activetalkers"
           type="activetalkersNotificationType" minOccurs="0"/&gt;
       &lt;/xs:sequence&gt;
       &lt;xs:attribute name="uniqueid" type="xs:string" use="required"/&gt;
       &lt;xs:attribute name="numtalkers" type="xs:string"
         use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="activetalkersNotificationType"&gt;
       &lt;xs:sequence minOccurs="0"&gt;
         &lt;xs:element name="talker" maxOccurs="unbounded"&gt;
           &lt;xs:complexType&gt;
             &lt;xs:attribute name="callid" type="xs:string"
              use="required"/&gt;
           &lt;/xs:complexType&gt;
         &lt;/xs:element&gt;
       &lt;/xs:sequence&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="keypressNotificationType"&gt;
       &lt;xs:sequence&gt;
         &lt;xs:element name="status" type="statusType"/&gt;
       &lt;/xs:sequence&gt;
       &lt;xs:attribute name="digit" type="DTMFkeyType" use="required"/&gt;
       &lt;xs:attribute name="length" use="required"&gt;
         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:NMTOKEN"&gt;
             &lt;xs:enumeration value="standard"/&gt;
             &lt;xs:enumeration value="long"/&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 70]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


       &lt;/xs:attribute&gt;
       &lt;xs:attribute name="method" use="required"&gt;
         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:NMTOKEN"&gt;
             &lt;xs:enumeration value="standard"/&gt;
             &lt;xs:enumeration value="long"/&gt;
             &lt;xs:enumeration value="double"/&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;
       &lt;/xs:attribute&gt;
       &lt;xs:attribute name="interdigittime" type="xs:string"
         use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="statusType"&gt;
       &lt;xs:attribute name="command" use="required"&gt;
         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:string"&gt;
             &lt;xs:enumeration value="idle"/&gt;
             &lt;xs:enumeration value="play"/&gt;
             &lt;xs:enumeration value="collect"/&gt;
             &lt;xs:enumeration value="record"/&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;
       &lt;/xs:attribute&gt;
       &lt;xs:attribute name="duration" type="xs:string" use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="signalNotificationType"&gt;
       &lt;xs:attribute name="type" use="required" fixed="busy"/&gt;
     &lt;/xs:complexType&gt;
     &lt;!-- Definitions for miscellaneous embedded, helper data types --&gt;
     &lt;xs:complexType name="promptType"&gt;
       &lt;xs:choice maxOccurs="unbounded"&gt;
         &lt;xs:element name="audio" type="promptcontentType"/&gt;
         &lt;xs:element name="variable" type="spokenvariableType"/&gt;
       &lt;/xs:choice&gt;
       &lt;xs:attribute name="locale" type="xs:string"/&gt;
       &lt;xs:attribute name="baseurl" type="xs:string"/&gt;
       &lt;xs:attribute name="stoponerror" type="yesnoType" default="no"/&gt;
       &lt;xs:attribute name="gain" type="xs:string" default="0"/&gt;
       &lt;xs:attribute name="gaindelta" type="xs:string" default="0"/&gt;
       &lt;xs:attribute name="rate" type="xs:string" default="0"/&gt;
       &lt;xs:attribute name="ratedelta" type="xs:string" default="0"/&gt;
       &lt;xs:attribute name="repeat" type="xs:string" default="1"/&gt;
       &lt;xs:attribute name="duration" type="xs:string"
         default="infinite"/&gt;
       &lt;xs:attribute name="offset" type="xs:string" default="0"/&gt;
       &lt;xs:attribute name="delay" type="xs:string" default="0"/&gt;
     &lt;/xs:complexType&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 71]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


     &lt;xs:complexType name="promptcontentType"&gt;
       &lt;xs:attribute name="url" type="xs:string" use="required"/&gt;
       &lt;xs:attribute name="encoding" type="xs:string"/&gt;
       &lt;xs:attribute name="gain" type="xs:string" default="0"/&gt;
       &lt;xs:attribute name="gaindelta" type="xs:string" default="0"/&gt;
       &lt;xs:attribute name="rate" type="xs:string" default="0"/&gt;
       &lt;xs:attribute name="ratedelta" type="xs:string" default="0"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="spokenvariableType"&gt;
       &lt;xs:attribute name="type" use="required"&gt;
         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:NMTOKEN"&gt;
             &lt;xs:enumeration value="dat"/&gt;
             &lt;xs:enumeration value="dig"/&gt;
             &lt;xs:enumeration value="dur"/&gt;
             &lt;xs:enumeration value="mth"/&gt;
             &lt;xs:enumeration value="mny"/&gt;
             &lt;xs:enumeration value="num"/&gt;
             &lt;xs:enumeration value="sil"/&gt;
             &lt;xs:enumeration value="str"/&gt;
             &lt;xs:enumeration value="tme"/&gt;
             &lt;xs:enumeration value="wkd"/&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;
       &lt;/xs:attribute&gt;
       &lt;xs:attribute name="subtype"&gt;
         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:NMTOKEN"&gt;
             &lt;xs:enumeration value="mdy"/&gt;
             &lt;xs:enumeration value="dmy"/&gt;
             &lt;xs:enumeration value="ymd"/&gt;
             &lt;xs:enumeration value="ndn"/&gt;
             &lt;xs:enumeration value="t12"/&gt;
             &lt;xs:enumeration value="t24"/&gt;
             &lt;xs:enumeration value="USD"/&gt;
             &lt;xs:enumeration value="gen"/&gt;
             &lt;xs:enumeration value="ndn"/&gt;
             &lt;xs:enumeration value="crd"/&gt;
             &lt;xs:enumeration value="ord"/&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;
       &lt;/xs:attribute&gt;
       &lt;xs:attribute name="value" type="xs:string" use="required"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:simpleType name="yesnoType"&gt;
       &lt;xs:restriction base="xs:NMTOKEN"&gt;
         &lt;xs:enumeration value="yes"/&gt;
         &lt;xs:enumeration value="no"/&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 72]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


         &lt;xs:enumeration value="1"/&gt;
         &lt;xs:enumeration value="0"/&gt;
         &lt;xs:enumeration value="true"/&gt;
         &lt;xs:enumeration value="false"/&gt;
       &lt;/xs:restriction&gt;
     &lt;/xs:simpleType&gt;
     &lt;xs:simpleType name="DTMFkeyType"&gt;
       &lt;xs:restriction base="xs:string"&gt;
         &lt;xs:pattern value="[0-9]"/&gt;
         &lt;xs:pattern value="[A-D]"/&gt;
         &lt;xs:pattern value="[a-d]"/&gt;
         &lt;xs:pattern value="#"/&gt;
         &lt;xs:pattern value="\*"/&gt;
       &lt;/xs:restriction&gt;
     &lt;/xs:simpleType&gt;
     &lt;xs:complexType name="gainType"&gt;
       &lt;xs:choice&gt;
         &lt;xs:element name="auto" type="autogainType"/&gt;
         &lt;xs:element name="fixed" type="fixedgainType"/&gt;
       &lt;/xs:choice&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="autogainType"&gt;
       &lt;xs:attribute name="startlevel" type="xs:string"/&gt;
       &lt;xs:attribute name="targetlevel" type="xs:string"/&gt;
       &lt;xs:attribute name="silencethreshold" type="xs:string"/&gt;
     &lt;/xs:complexType&gt;
     &lt;xs:complexType name="fixedgainType"&gt;
       &lt;xs:attribute name="level" type="xs:string"/&gt;
     &lt;/xs:complexType&gt;
   &lt;/xs:schema&gt;

<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>.  IANA Considerations</span>

<span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>.  IANA Registration of MIME Media Type application/</span>
<span class="h3">      mediaservercontrol+xml</span>

      MIME media type name: application
      MIME subtype name: mediaservercontrol+xml
      Required parameters: none
      Optional parameters: charset

      charset This parameter has identical semantics to the charset
         parameter of the "application/xml" media type, as specified in
         XML Media Types [<a href="#ref-8" title="&quot;XML Media Types&quot;">8</a>].

   Encoding considerations: See <a href="./rfc3023">RFC 3023</a> [<a href="#ref-8" title="&quot;XML Media Types&quot;">8</a>].
   Interoperability considerations: See <a href="./rfc2023">RFC 2023</a> [<a href="#ref-8" title="&quot;XML Media Types&quot;">8</a>] and <a href="./rfc5022">RFC 5022</a>.
   Published specification: <a href="./rfc5022">RFC 5022</a>



<span class="grey">Van Dyke, et al.             Informational                     [Page 73]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   Applications that use this media type: Multimedia, enhanced
      conferencing and interactive applications.
   Personal and email address for further
      information: eburger@cantata.com [<a href="#ref-31">31</a>]
   Intended usage: COMMON

<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>.  Security Considerations</span>

   Because media flows through a media server in a conference, the media
   server itself MUST protect the integrity, confidentiality, and
   security of the sessions.  It should not be possible for a conference
   participant, on her own behalf, to be able to "tap in" to another
   conference without proper authorization.

   Because conferencing is a high-value application, the media server
   SHOULD implement appropriate security measures.  This includes, but
   is not limited to, access lists for application servers.  That is,
   the media server only allows a select list of application or proxy
   servers to create conferences, to invite participants to sessions,
   etc.  Note that the mechanisms for such security, like private
   networks, shared certificates, MAC white/black lists, are beyond the
   scope of this document.

   Security concerns are one important reason MSCML limits requests with
   conference scope to a separate control leg per conference.  MSCML
   uses the simple, proven, Internet-scale security model of SIP to
   determine if a client is who they say they are (authentication) and
   if they are allowed to create and manipulate a conference.  However,
   the security model to enable a control leg to manipulate arbitrary
   conferences on the media server is extremely difficult.  Not only
   would one need to authenticate and authorize the basic conference
   primitives, but privacy considerations require policies for one
   client to access another client's conferences, even if the two
   clients are on the same host.  For example, if the media server
   allowed any control leg to control any conference, an authorized but
   unrelated client could maliciously attach itself to an existing
   session and record or tap the conversation without the participant's
   knowledge or consent.

   Participants give implicit authorization to their applications by
   virtue of the INVITE to the application.  However, there is no trust,
   explicit or implicit, between the users of one service and a distinct
   client of another service.

   All MSCML messages are sent within an INVITE-created SIP dialog.  As
   a result, it would be difficult for an entity other than the original
   requestor to interfere with an established MSCML session, as this
   would require detailed information on the dialog state.  This allows



<span class="grey">Van Dyke, et al.             Informational                     [Page 74]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   multiple applications to utilize the resources of a single media
   server simultaneously without interfering with one another.

   Because of the sensitive nature of collected data, such as credit
   card numbers or other identifying information, the media server MUST
   support sips: and TLS.  Clients, who presumably know the value of the
   information they collect, as well as the privacy expectations of
   their users, are free to use clear text signaling or encrypted secure
   signaling, depending on the application's needs.  Likewise, the media
   server SHOULD support Secure Realtime Transport Protocol (SRTP) [<a href="#ref-9" title="&quot;The Secure Real-time Transport Protocol (SRTP)&quot;">9</a>].
   Again, the clients are free to negotiate the appropriate level of
   media security.

   The media management facilities of MSCML, such as the &lt;managecontent&gt;
   (<a href="#section-8">Section 8</a>) request, assume a trust relationship between the media
   server and file server.  This scenario is similar to the one
   addressed by URLAUTH [<a href="#ref-20" title="&quot;Internet Message Access Protocol (IMAP) - URLAUTH Extension&quot;">20</a>].  Namely, the media server is acting on
   behalf of a given user, yet the media server does not have
   credentials for that user.  One might be tempted to use the user:pass
   facility of the HTTP URI to offer per-user security, but that also
   requires that the media server be secure, as the media server would
   need to know the user credentials in a form that is easily
   compromised (clear text passwords).

   The IETF is investigating methods for providing per-user or per-
   instance authorization of third-party http writing, as is needed for
   other protocols as well, such as WEBDAV [<a href="#ref-21" title="&quot;HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)&quot;">21</a>].  However, until that
   work is completed, media server implementations MUST be prepared to
   authenticate themselves to file and web servers using appropriate
   authentication means.  At a minimum, the media server MUST support
   HTTPS basic authentication.  Implementers should note that the media
   server will need to respond appropriately to whatever authentication
   mechanism the file server requires.

   As this is an XML markup, all the security considerations of <a href="./rfc3023">RFC 3023</a>
   [<a href="#ref-8" title="&quot;XML Media Types&quot;">8</a>] apply.

<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>.  References</span>

<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>.  Normative References</span>

   [<a id="ref-1">1</a>]   Bradner, S., "Key words for use in RFCs to Indicate Requirement
         Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.

   [<a id="ref-2">2</a>]   Burger, E., Van Dyke, J., and A. Spitzer, "Basic Network Media
         Services with SIP", <a href="./rfc4240">RFC 4240</a>, December 2005.

   [<a id="ref-3">3</a>]   Donovan, S., "The SIP INFO Method", <a href="./rfc2976">RFC 2976</a>, October 2000.



<span class="grey">Van Dyke, et al.             Informational                     [Page 75]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   [<a id="ref-4">4</a>]   Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A.,
         Peterson, J., Sparks, R., Handley, M., and E. Schooler, "SIP:
         Session Initiation Protocol", <a href="./rfc3261">RFC 3261</a>, June 2002.

   [<a id="ref-5">5</a>]   "Network call signalling protocol for the delivery of time-
         critical services over cable television networks using cable
         modems", ITU-T J.162, March 2001.

   [<a id="ref-6">6</a>]   Groves, C., Pantaleo, M., Anderson, T., and T. Taylor, "Gateway
         Control Protocol Version 1", <a href="./rfc3525">RFC 3525</a>, June 2003.

   [<a id="ref-7">7</a>]   Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn, "XML
         Schema Part 1: Structures", W3C REC REC-xmlschema-1-20010502,
         May 2001.

   [<a id="ref-8">8</a>]   Murata, M., St. Laurent, S., and D. Kohn, "XML Media Types",
         <a href="./rfc3023">RFC 3023</a>, January 2001.

   [<a id="ref-9">9</a>]   Baugher, M., McGrew, D., Naslund, M., Carrara, E., and K.
         Norrman, "The Secure Real-time Transport Protocol (SRTP)", <a href="./rfc3711">RFC</a>
         <a href="./rfc3711">3711</a>, March 2004.

<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>.  Informative References</span>

   [<a id="ref-10">10</a>]  Rosenberg, J., "A Framework for Conferencing with the Session
         Initiation Protocol (SIP)", <a href="./rfc4353">RFC 4353</a>, February 2006.

   [<a id="ref-11">11</a>]  Carter, J., Danielsen, P., Hunt, A., Ferrans, J., Lucas, B.,
         Porter, B., Rehor, K., Tryphonas, S., McGlashan, S., and D.
         Burnett, "Voice Extensible Markup Language (VoiceXML) Version
         2.0", W3C REC REC-voicexml20-20040316, March 2004.

   [<a id="ref-12">12</a>]  International Packet Communications Consortium, "IPCC Reference
         Architecture V2", June 2002.

   [<a id="ref-13">13</a>]  European Telecommunications Standards Institute, "Digital
         cellular telecommunications system (Phase 2+); Universal Mobile
         Telecommunications System (UMTS); IP Multimedia Subsystem
         (IMS); Stage 2 (3GPP TS 23.228 version 7.2.0 Release 7)",
         December 2005.

   [<a id="ref-14">14</a>]  Hollenbeck, S., Rose, M., and L. Masinter, "Guidelines for the
         Use of Extensible Markup Language (XML) within IETF Protocols",
         <a href="https://www.rfc-editor.org/bcp/bcp70">BCP 70</a>, <a href="./rfc3470">RFC 3470</a>, January 2003.

   [<a id="ref-15">15</a>]  Jacobs, I., Lie, H., Bos, B., and C. Lilley, "Cascading Style
         Sheets, level 2 (CSS2) Specification", W3C REC REC-CSS2-
         19980512, May 1998.



<span class="grey">Van Dyke, et al.             Informational                     [Page 76]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


   [<a id="ref-16">16</a>]  Rosenberg, J., Schulzrinne, H., and O. Levin, "A Session
         Initiation Protocol (SIP) Event Package for Conference State",
         <a href="./rfc4575">RFC 4575</a>, August 2006.

   [<a id="ref-17">17</a>]  Cable Television Laboratories, Inc., "Audio Server Protocol",
         January 2005.

   [<a id="ref-18">18</a>]  "Procedures for document facsimile transmission in the general
         switched telephone network", Recommendation T.30, April 1999.

   [<a id="ref-19">19</a>]  "Procedures for real-time Group 3 facsimile communication over
         IP networks", Recommendation T.38, March 2002.

   [<a id="ref-20">20</a>]  Crispin, M., "Internet Message Access Protocol (IMAP) - URLAUTH
         Extension", <a href="./rfc4467">RFC 4467</a>, May 2006.

   [<a id="ref-21">21</a>]  Dusseault, L., Ed., "HTTP Extensions for Web Distributed
         Authoring and Versioning (WebDAV)", <a href="./rfc4918">RFC 4918</a>, June 2007.

   [<a id="ref-22">22</a>]  Institute of Electrical and Electronics Engineers, "Information
         Technology - Portable Operating System Interface (POSIX) - Part
         1: Base Definitions, Chapter 9", IEEE Standard 1003.1, June
         2001.

   [<a id="ref-23">23</a>]  Burger, E. and M. Dolly, "A Session Initiation Protocol (SIP)
         Event Package for Key Press Stimulus (KPML)", <a href="./rfc4730">RFC 4730</a>,
         November 2006.

   [<a id="ref-24">24</a>]  Klensin, J., "Simple Mail Transfer Protocol", <a href="./rfc2821">RFC 2821</a>, April
         2001.

   [<a id="ref-25">25</a>]  Campbell, B., Ed., Mahy, R., Ed., and C. Jennings, Ed., "The
         Message Session Relay Protocol", Work in Progress, February
         2007.

URIs

   [<a id="ref-26">26</a>]  &lt;<a href="http://www.ietf.org/html.charters/sip-charter.html">http://www.ietf.org/html.charters/sip-charter.html</a>&gt;

   [<a id="ref-27">27</a>]  &lt;<a href="http://www.ietf.org/html.charters/sipping-charter.html">http://www.ietf.org/html.charters/sipping-charter.html</a>&gt;

   [<a id="ref-28">28</a>]  &lt;<a href="http://www.ietf.org/html.charters/mmusic.html">http://www.ietf.org/html.charters/mmusic.html</a>&gt;

   [<a id="ref-29">29</a>]  &lt;<a href="http://www.ietf.org/html.charters/xcon-charter.html">http://www.ietf.org/html.charters/xcon-charter.html</a>&gt;

   [<a id="ref-30">30</a>]  &lt;<a href="http://www.3gpp.org/ftp/Specs/html-info/23228.htm">http://www.3gpp.org/ftp/Specs/html-info/23228.htm</a>&gt;

   [<a id="ref-31">31</a>]  &lt;mailto:eburger@cantata.com&gt;



<span class="grey">Van Dyke, et al.             Informational                     [Page 77]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>.  Regex Grammar Syntax</span>

   The regular expression syntax used in MSCML is a telephony-oriented
   subset of POSIX Extended Regular Expressions (ERE) [<a href="#ref-22" title="&quot;Information Technology - Portable Operating System Interface (POSIX) - Part 1: Base Definitions, Chapter 9&quot;">22</a>] termed Digit
   REGular EXpression (DRegex).  This syntax was first described in KPML
   [<a href="#ref-23" title="&quot;A Session Initiation Protocol (SIP) Event Package for Key Press Stimulus (KPML)&quot;">23</a>].

   DRegex includes ordinary characters, special characters, bracket
   expressions, and interval expressions.  These entities are defined in
   the list below.

   . matches digits 0-9, *, #, and A-D (case insensitive)
   *  matches the * character
   #  matches the # character
   [character selector] matches any character in selector
   [range1-range2] matches any character in range from range1 to range2,
      inclusive
   x  matches any digit 0-9
   {m} matches m repetitions of the previous pattern
   {m,} matches m or more repetitions of the previous pattern
   {,n} matches at most n (including zero) repetitions of the previous
      pattern
   {m,n} at least m and at most n repetitions of the previous pattern
   L  the presence of 'L' in any regex expression causes the media
      server to enable "long" digit detection mode.  See <a href="#section-7.1">Section 7.1</a> for
      the definition of "long" digits.

   Table 7 illustrates DRegex usage through examples.

       +--------------+--------------------------------------------+
       | Example      | Description                                |
       +--------------+--------------------------------------------+
       | 1            | Matches the digit 1                        |
       | [179]        | Matches 1, 7, or 9                         |
       | [2-9]        | Matches 2, 3, 4, 5, 6, 7, 8, 9             |
       | [02-46-9A-D] | Matches 0, 2, 3, 4, 6, 7, 8, 9, A, B, C, D |
       | x            | Matches 0, 1, 2, 3, 4, 5, 6, 7, 8, 9       |
       | .            | Matches 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, A, B,|
       |              | C, D, #, *                                 |
       | *6[179#]     | Matches *61, *67, *69, or *6#              |
       | x{10}        | Ten digits (0-9)                           |
       | 011x{7,15}   | 011 followed by seven to fifteen digits    |
       | L*           | Long star                                  |
       +--------------+--------------------------------------------+

                         Table 7: DRegex Examples





<span class="grey">Van Dyke, et al.             Informational                     [Page 78]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-79" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>.  Contributors</span>

   Jeff Van Dyke and Andy Spitzer did the concept, development,
   documentation, and execution for MSCML at SnowShore Networks, Inc.,
   which is now part of Cantata Technology, Inc.  Andy Spitzer's
   original work at The Telephone Connection, Inc., influenced the IVR
   implementation.  Mary Ann Leekley implemented the personalized mix
   feature and several other enhancements.

   Cliff Schornak of Commetrex and Jeff Van Dyke developed the facsimile
   service.

   Jai Cauvet, Rolando Herrero, Srinivas Motamarri, and Ashish Patel
   contributed greatly by testing MSCML.

<span class="h2"><a class="selflink" id="appendix-C" href="#appendix-C">Appendix C</a>.  Acknowledgements</span>

   The following individuals provided valuable assistance in the
   direction, development, or debugging of MSCML:

   o  Brian Badger and Phil Crable from Verizon Business
   o  Stephane Bastien from BroadSoft
   o  Peter Danielsen of Lucent Technologies
   o  Kevin Flemming, formerly of SnowShore Networks, Inc.
   o  Wesley Hicks and Ravindra Kabre, formerly from Sonus Networks
   o  Jon Hinckley from SkyWave/Sestro
   o  Terence Lobo, formerly of SnowShore Networks, Inc.
   o  Kunal Nawale, formerly of SnowShore Networks, Inc.
   o  Edwina Nowicki, formerly of SnowShore Networks, Inc.
   o  Diana Rawlins and Sharadha Vijay, formerly of WorldCom
   o  Gaurav Srivastva and Subhash Verma from BayPackets
   o  Kevin Summers from Sonus Networks
   o  Tim Wong from at&amp;t

   The authors would like to thank Cullen Jennings and Dan Wing from
   Cisco Systems for their helpful review comments.

   The authors would also like to thank Scotty Farber for applying her
   technical writing expertise to the documentation of MSCML.












<span class="grey">Van Dyke, et al.             Informational                     [Page 79]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-80" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


Authors' Addresses

   Jeff Van Dyke
   Cantata Technology, Inc.
   18 Keewaydin Dr.
   Salem, NH  03079
   USA

   EMail: jvandyke@cantata.com


   Eric Burger (editor)
   BEA Systems, Inc.
   USA

   Email: eburger@standardstrack.com
   URI: <a href="http://www.standardstrack.com">http://www.standardstrack.com</a>


   Andy Spitzer
   Bluesocket Inc.
   10 North Avenue
   Burlington, MA  01803
   USA

   EMail: woof@pingtel.com

























<span class="grey">Van Dyke, et al.             Informational                     [Page 80]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-81" ></span>
<span class="grey"><a href="./rfc5022">RFC 5022</a>                         MSCML                    September 2007</span>


Full Copyright Statement

   Copyright (C) The IETF Trust (2007).

   This document is subject to the rights, licenses and restrictions
   contained in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and at www.rfc-editor.org/copyright.html, and
   except as set forth therein, the authors retain all their rights.

   This document and the information contained herein are provided on an
   "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
   OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST,
   AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
   THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
   IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
   PURPOSE.

Intellectual Property

   The IETF takes no position regarding the validity or scope of any
   Intellectual Property Rights or other rights that might be claimed to
   pertain to the implementation or use of the technology described in
   this document or the extent to which any license under such rights
   might or might not be available; nor does it represent that it has
   made any independent effort to identify any such rights.  Information
   on the procedures with respect to rights in RFC documents can be
   found in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>.

   Copies of IPR disclosures made to the IETF Secretariat and any
   assurances of licenses to be made available, or the result of an
   attempt made to obtain a general license or permission for the use of
   such proprietary rights by implementers or users of this
   specification can be obtained from the IETF on-line IPR repository at
   <a href="http://www.ietf.org/ipr">http://www.ietf.org/ipr</a>.

   The IETF invites any interested party to bring to its attention any
   copyrights, patents or patent applications, or other proprietary
   rights that may cover technology that may be required to implement
   this standard.  Please address the information to the IETF at
   ietf-ipr@ietf.org.











Van Dyke, et al.             Informational                     [Page 81]
</pre>