<pre>Network Working Group                                          E. Burger
Request for Comments: 4730                      Cantata Technology, Inc.
Category: Standards Track                                       M. Dolly
                                                               AT&amp;T Labs
                                                           November 2006


           <span class="h1">A Session Initiation Protocol (SIP) Event Package</span>
                     <span class="h1">for Key Press Stimulus (KPML)</span>

Status of This Memo

   This document specifies an Internet standards track protocol for the
   Internet community, and requests discussion and suggestions for
   improvements.  Please refer to the current edition of the "Internet
   Official Protocol Standards" (STD 1) for the standardization state
   and status of this protocol.  Distribution of this memo is unlimited.

Copyright Notice

   Copyright (C) The IETF Trust (2006).

Abstract

   This document describes a SIP Event Package "kpml" that enables
   monitoring of Dual Tone Multi-Frequency (DTMF) signals and uses
   Extensible Markup Language (XML) documents referred to as Key Press
   Markup Language (KPML).  The kpml Event Package may be used to
   support applications consistent with the principles defined in the
   document titled "A Framework for Application Interaction in the
   Session Initiation Protocol (SIP)".  The event package uses SUBSCRIBE
   messages and allows for XML documents that define and describe filter
   specifications for capturing key presses (DTMF Tones) entered at a
   presentation-free User Interface SIP User Agent (UA).  The event
   package uses NOTIFY messages and allows for XML documents to report
   the captured key presses (DTMF tones), consistent with the filter
   specifications, to an Application Server.  The scope of this package
   is for collecting supplemental key presses or mid-call key presses
   (triggers).












<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</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>. Protocol Overview ...............................................<a href="#page-5">5</a>
   <a href="#section-3">3</a>. Key Concepts ....................................................<a href="#page-6">6</a>
      <a href="#section-3.1">3.1</a>. Subscription Duration ......................................<a href="#page-6">6</a>
      <a href="#section-3.2">3.2</a>. Timers .....................................................<a href="#page-7">7</a>
      <a href="#section-3.3">3.3</a>. Pattern Matches ............................................<a href="#page-8">8</a>
      <a href="#section-3.4">3.4</a>. Digit Suppression .........................................<a href="#page-12">12</a>
      <a href="#section-3.5">3.5</a>. User Input Buffer Behavior ................................<a href="#page-14">14</a>
      <a href="#section-3.6">3.6</a>. DRegex ....................................................<a href="#page-16">16</a>
           <a href="#section-3.6.1">3.6.1</a>. Overview ...........................................<a href="#page-16">16</a>
           <a href="#section-3.6.2">3.6.2</a>. Operation ..........................................<a href="#page-18">18</a>
      <a href="#section-3.7">3.7</a>. Monitoring Direction ......................................<a href="#page-20">20</a>
      <a href="#section-3.8">3.8</a>. Multiple Simultaneous Subscriptions .......................<a href="#page-20">20</a>
   <a href="#section-4">4</a>. Event Package Formal Definition ................................<a href="#page-21">21</a>
      <a href="#section-4.1">4.1</a>. Event Package Name ........................................<a href="#page-21">21</a>
      <a href="#section-4.2">4.2</a>. Event Package Parameters ..................................<a href="#page-21">21</a>
      <a href="#section-4.3">4.3</a>. SUBSCRIBE Bodies ..........................................<a href="#page-22">22</a>
      <a href="#section-4.4">4.4</a>. Subscription Duration .....................................<a href="#page-22">22</a>
      <a href="#section-4.5">4.5</a>. NOTIFY Bodies .............................................<a href="#page-22">22</a>
      <a href="#section-4.6">4.6</a>. Subscriber Generation of SUBSCRIBE Requests ...............<a href="#page-22">22</a>
      <a href="#section-4.7">4.7</a>. Notifier Processing of SUBSCRIBE Requests .................<a href="#page-23">23</a>
      <a href="#section-4.8">4.8</a>. Notifier Generation of NOTIFY Requests ....................<a href="#page-25">25</a>
      <a href="#section-4.9">4.9</a>. Subscriber Processing of NOTIFY Requests ..................<a href="#page-27">27</a>
      <a href="#section-4.10">4.10</a>. Handling of Forked Requests ..............................<a href="#page-28">28</a>
      <a href="#section-4.11">4.11</a>. Rate of Notifications ....................................<a href="#page-28">28</a>
      <a href="#section-4.12">4.12</a>. State Agents and Lists ...................................<a href="#page-28">28</a>
      <a href="#section-4.13">4.13</a>. Behavior of a Proxy Server ...............................<a href="#page-29">29</a>
   <a href="#section-5">5</a>. Formal Syntax ..................................................<a href="#page-29">29</a>
      <a href="#section-5.1">5.1</a>. DRegex ....................................................<a href="#page-29">29</a>
      <a href="#section-5.2">5.2</a>. KPML Request ..............................................<a href="#page-30">30</a>
      <a href="#section-5.3">5.3</a>. KPML Response .............................................<a href="#page-33">33</a>
   <a href="#section-6">6</a>. Enumeration of KPML Status Codes ...............................<a href="#page-34">34</a>
   <a href="#section-7">7</a>. IANA Considerations ............................................<a href="#page-34">34</a>
      <a href="#section-7.1">7.1</a>. SIP Event Package Registration ............................<a href="#page-34">34</a>
      <a href="#section-7.2">7.2</a>. MIME Media Type application/kpml-request+xml ..............<a href="#page-35">35</a>
      <a href="#section-7.3">7.3</a>. MIME Media Type application/kpml-response+xml .............<a href="#page-35">35</a>
      7.4. URN Sub-Namespace Registration for
           urn:ietf:xml:ns:kpml-request ..............................<a href="#page-35">35</a>
      7.5. URN Sub-Namespace Registration for
           urn:ietf:xml:ns:kpml-response .............................<a href="#page-36">36</a>
      <a href="#section-7.6">7.6</a>. KPML Request Schema Registration ..........................<a href="#page-37">37</a>
      <a href="#section-7.7">7.7</a>. KPML Response Schema Registration .........................<a href="#page-37">37</a>
   <a href="#section-8">8</a>. Security Considerations ........................................<a href="#page-37">37</a>
   <a href="#section-9">9</a>. Examples .......................................................<a href="#page-38">38</a>
      <a href="#section-9.1">9.1</a>. Monitoring for Octothorpe .................................<a href="#page-38">38</a>



<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


      <a href="#section-9.2">9.2</a>. Dial String Collection ....................................<a href="#page-39">39</a>
   <a href="#section-10">10</a>. Call Flow Examples ............................................<a href="#page-40">40</a>
      <a href="#section-10.1">10.1</a>. Supplemental Digits ......................................<a href="#page-40">40</a>
      <a href="#section-10.2">10.2</a>. Multiple Applications ....................................<a href="#page-45">45</a>
   <a href="#section-11">11</a>. References ....................................................<a href="#page-52">52</a>
      <a href="#section-11.1">11.1</a>. Normative References .....................................<a href="#page-52">52</a>
      <a href="#section-11.2">11.2</a>. Informative References ...................................<a href="#page-53">53</a>
   <a href="#appendix-A">Appendix A</a>.  Contributors .........................................<a href="#page-54">54</a>
   <a href="#appendix-B">Appendix B</a>.  Acknowledgements .....................................<a href="#page-54">54</a>










































<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


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

   This document describes a SIP Event Package "kpml" that enables
   monitoring of key presses and utilizes XML documents referred to as
   Key Press Markup Language (KPML).  KPML is a markup [<a href="#ref-14" title="&quot;Extensible Markup Language (XML) 1.0 (Second Edition)&quot;">14</a>] that enables
   presentation-free User Interfaces as described in the Application
   Interaction Framework [<a href="#ref-15" title="&quot;A Framework for Application Interaction in the Session Initiation Protocol (SIP)&quot;">15</a>].  The Key Press Stimulus Package is a SIP
   Event Notification Package [<a href="#ref-5" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">5</a>] that uses the SUBSCRIBE and NOTIFY
   methods of SIP.  The subscription filter and notification report
   bodies use the Keypad Markup Language, KPML.

   The "kpml" event package requires the definition of two new MIME
   types, two new URN sub-namespaces, and two schemas for the KPML
   Request and the KPML Response.  The scope of this package is for
   collecting supplemental key presses or mid-call key presses
   (triggers).  This capability allows an Application Server service
   provider to monitor (filter) for a set of DTMF patterns at a SIP User
   Agent located in either an end-user device or a gateway.

   In particular, the "kpml" event package enables "dumb phones" and
   "gateways" that receive signals from dumb phones to report user key-
   press events.  Colloquially, this mechanism provides for "digit
   reporting" or "Dual Tone Multi-Frequency (DTMF) reporting."  The
   capability eliminates the need for "hair-pinning" (routing media into
   and then out of the same device) through a Media Server or
   duplicating all the DTMF events, when an Application Server needs to
   trigger mid-call service processing on DTMF digit patterns.

   A goal of KPML is to fit in an extremely small memory and processing
   footprint.

   The name of the XML document, KPML, reflects its legacy support role.
   The public switched telephony network (PSTN) accomplished signaling
   by transporting DTMF tones in the bearer channel (in-band signaling)
   from the user terminal to the local exchange.

   Voice-over-IP networks transport in-band signals with actual DTMF
   waveforms or <a href="./rfc2833">RFC 2833</a> [<a href="#ref-10" title="&quot;RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals&quot;">10</a>] packets.  In <a href="./rfc2833">RFC 2833</a>, the signaling
   application inserts <a href="./rfc2833">RFC 2833</a> named signal packets as well as, or
   instead of, generating tones in the media path.  The receiving
   application receives the signal information in the media stream.

   <a href="./rfc2833">RFC 2833</a> tones are ideal for conveying telephone-events point-to-
   point in a Real-time Transport Protocol (RTP) stream, as in the
   context of straightforward sessions like a 2-party call or a simple,
   centrally mixed conference.  However, there are other environments
   where additional or alternative requirements are needed.  These other
   environments include protocol translation and complex call control.



<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   An interested application could request notifications of every key
   press.  However, many of the use cases for such signaling show that
   most applications are interested in only one or a few keystrokes.
   Thus a mechanism is needed for specifying to the user's interface
   what stimuli the application requires.

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

   <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>] provides the interpretations for the key words "MUST",
   "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
   "RECOMMENDED", "MAY", and "OPTIONAL" found in this document.

   The Application Interaction Framework document [<a href="#ref-15" title="&quot;A Framework for Application Interaction in the Session Initiation Protocol (SIP)&quot;">15</a>] provides the
   interpretations for the terms "User Device", "SIP Application", and
   "User Input".  This document uses the term "Application" and
   "Requesting Application" interchangeably with "SIP Application".

   Additionally, the Application Interaction Framework document
   discusses User Device Proxies.  A common instantiation of a User
   Device Proxy is a Public Switched Telephone Network (PSTN) gateway.
   Because the normative behavior of a presentation-free User Interface
   is identical for a presentation-free SIP User Agent and a
   presentation-free User Device Proxy, this document uses "User Device"
   for both cases.

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

   The "kpml" event package uses explicit subscription notification
   requests using the SIP SUBSCRIBE and NOTIFY methods.  An Application
   that wants to collect digits creates an application/kpml-request+xml
   document with the digit patterns of interest to the Application and
   places this document in its SUBSCRIBE request.  SIP SUBSCRIBE
   messages are routed to the User Interface using standard SIP request
   routing.  KPML Subscriptions do not fork.  The KPML request contained
   in the SUBSCRIBE message identifies the target media stream by
   referencing the dialog identifiers corresponding to the session
   responsible for the media stream.  Once a subscription is
   established, the User Interface sends application/kpml-response+xml
   documents in NOTIFY requests when digits are collected or when
   timeouts or errors occur.

   A KPML subscription can be persistent or one-shot.  Persistent
   requests are active until the subscription terminates, the
   Application replaces the request, the Application deletes the request
   by sending a null document on the dialog, or the Application
   explicitly deletes the subscription by sending a SUBSCRIBE with an
   expires value of zero (0).




<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   One-shot requests terminate the subscription upon the receipt of DTMF
   values that provide a match.  The "persist" KPML element specifies
   whether the subscription remains active for the duration specified in
   the SUBSCRIBE message or if it automatically terminates upon a
   pattern match.

   NOTIFY messages can contain XML documents.  If the User Interface
   matches a digitmap, the NOTIFY message (response) contains an XML
   document that indicates the User Input detected and whether the User
   Interface suppressed the representation of User Input, such as tones,
   or <a href="./rfc2833">RFC 2833</a>, from the media streams.  If the User Interface
   encountered an error condition, such as a timeout, this will also be
   reported.

<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>.  Key Concepts</span>

<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>.  Subscription Duration</span>

   KPML recognizes two types of subscriptions: one-shot and persistent.
   Persistent subscriptions have two sub-types: continuous notify and
   single-notify.

   One-shot subscriptions terminate after a pattern match occurs and a
   report is issued in a NOTIFY message.  If the User Interface detects
   a key press stimulus that triggers a one-shot KPML event, then the
   User Interface (notifier) MUST set the "Subscription-State" in the
   NOTIFY message to "terminated".  At this point, the User Interface
   MUST consider the subscription expired.

   Persistent subscriptions remain active at the User Interface, even
   after a match.  For continuous-notify persistent subscriptions, the
   User Interface will emit a NOTIFY message whenever the User Input
   matches a subscribed pattern.  For single-notify persistent
   subscriptions, the user device will emit a NOTIFY message at the
   first match, but will not emit further NOTIFY messages until the
   Application issues a new subscription request on the subscription
   dialog.

      NOTE: The single-notify persistent subscription enables lock-step
      (race-free) quarantining of User Input between different digit
      maps.

   The "persist" attribute to the &lt;pattern&gt; tag in the KPML subscription
   body affects the lifetime of the subscription.

   If the "persist" attribute is "one-shot", then once there is a match
   (or no match is possible), the subscription ends after the User
   Interface notifies the Application.



<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   If the "persist" attribute is "persist" or "single-notify", then the
   subscription ends when the Application explicitly ends it or the User
   Interface terminates the subscription.

   If the User Interface does not support persistent subscriptions, it
   returns a NOTIFY message with the KPML status code set to 531.  If
   there are digits in the buffer and the digits match an expression in
   the SUBSCRIBE filter, the User Interface prepares the appropriate
   NOTIFY response message.

   The values of the "persist" attribute are case sensitive.

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

   To address the various key press collection scenarios, three timers
   are defined.  They are the extra, critical, and inter-digit timers.

   o  The inter-digit timer is the maximum time to wait between digits.
      Note: unlike Media Gateway Control Protocol (MGCP) [<a href="#ref-11" title="&quot;Media Gateway Control Protocol (MGCP) Version 1.0&quot;">11</a>] or H.248
      [<a href="#ref-12" title="&quot;Gateway Control Protocol Version 1&quot;">12</a>], there is no start timer, as that concept does not apply in
      the KPML context.

   o  The critical timer is the time to wait for another digit if the
      collected digits can match more than one potential pattern.

   o  The extra timer is the time to wait for another digit if the
      collected digits can only match one potential pattern, but a
      longer match for this pattern is possible.

   The User Interface MAY support an inter-digit timeout value.  This is
   the amount of time the User Interface will wait for User Input before
   returning a timeout error result on a partially matched pattern.  The
   application can specify the inter-digit timeout as an integer number
   of milliseconds by using the "interdigittimer" attribute to the
   &lt;pattern&gt; tag.  The default is 4000 milliseconds.  If the User
   Interface does not support the specification of an inter-digit
   timeout, the User Interface MUST silently ignore the specification.
   If the User Interface supports the specification of an inter-digit
   timeout, but not to the granularity specified by the value presented,
   the User Interface MUST round up the requested value to the closest
   value it can support.

   The purpose of the inter-digit timeout is to protect applications
   from starting to match a pattern, yet never returning a result.  This
   can occur, for example, if the user accidentally enters a key that
   begins to match a pattern.  However, since the user accidentally
   entered the key, the rest of the pattern never comes.  Moreover, when
   the user does enter a pattern, since they have already entered a key,



<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   the pattern may not match or may not match as expected.  Likewise,
   consider the case where the user thinks they entered a key press, but
   the User Interface does not detect the key.  This could occur when
   collecting ten digits, but the device actually only receives 9.  In
   this case, the User Interface will wait forever for the tenth key
   press, while the user becomes frustrated wondering why the
   application is not responding.

   The User Interface MAY support a critical-digit timeout value.  This
   is the amount of time the User Interface will wait for another key
   press when it already has a matched &lt;regex&gt; but there is another,
   longer &lt;regex&gt; that may also match the pattern.  The application can
   specify the critical-digit timeout as an integer number of
   milliseconds by using the "criticaldigittimer" attribute to the
   &lt;pattern&gt; tag.  The default is 1000 milliseconds.

   The purpose of the critical-digit timeout is to allow the application
   to collect longer matches than the shortest presented.  This is
   unlike MGCP [<a href="#ref-11" title="&quot;Media Gateway Control Protocol (MGCP) Version 1.0&quot;">11</a>], where the shortest match gets returned.  For
   example, if the application registers for the patterns "0011", "011",
   "00", and "0", the critical-digit timeout enables the User Interface
   to distinguish between "0", "00", "011", and "0011".  Without this
   feature, the only value that the User Interface can detect is "0".

   The User Interface MAY support an extra-digit timeout value.  This is
   the amount of time the User Interface will wait for another key press
   when it already has matched the longest &lt;regex&gt;.  The application can
   specify the extra-digit timeout as an integer number of milliseconds
   by using the "extradigittimer" attribute to the &lt;pattern&gt; tag.  The
   default is 500 milliseconds.  If there is no enterkey specified, then
   the User Interface MAY default the exteradigittimer to zero.

   The purpose of the extra-digit timeout is to allow the User Interface
   to collect the enterkey.  Without this feature, the User Interface
   would match the pattern, and the enterkey would be buffered and
   returned as the next pattern.

<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>.  Pattern Matches</span>

   During the subscription lifetime, the User Interface may detect a key
   press stimulus that triggers a KPML event.  In this case, the User
   Interface (notifier) MUST return the appropriate KPML document.

   The pattern matching logic works as follows.  KPML User Interfaces
   MUST follow the logic presented in this section so that different
   implementations will perform deterministically on the same KPML
   document given the same User Input.




<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   A kpml request document contains a &lt;pattern&gt; element with a series of
   &lt;regex&gt; tags.  Each &lt;regex&gt; element specifies a potential pattern for
   the User Interface to match.  The <a href="#section-5.1">Section 5.1</a> describes the DRegex,
   or digit regular expression, language.

   The pattern match algorithm matches the longest regular expression.
   This is the same mode as H.248.1 [<a href="#ref-12" title="&quot;Gateway Control Protocol Version 1&quot;">12</a>] and not the mode presented by
   MGCP [<a href="#ref-11" title="&quot;Media Gateway Control Protocol (MGCP) Version 1.0&quot;">11</a>].  The pattern match algorithm choice has an impact on
   determining when a pattern matches.  Consider the following KPML
   document.

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-request xmlns="urn:ietf:params:xml:ns:kpml-request"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-request kpml-request.xsd"
         version="1.0"&gt;
     &lt;pattern&gt;
       &lt;regex&gt;0&lt;/regex&gt;
       &lt;regex&gt;011&lt;/regex&gt;
     &lt;/pattern&gt;
   &lt;/kpml-request&gt;

                         Figure 1: Greedy Matching

   In Figure 1, if we were to match on the first found pattern, the
   string "011" would never match.  This happens because the "0" rule
   would match first.

   While this behavior is what most applications desire, it does come at
   a cost.  Consider the following KPML document snippet.

     &lt;regex&gt;x{7}&lt;/regex&gt;
     &lt;regex&gt;x{10}&lt;/regex&gt;

                        Figure 2: Timeout Matching

   Figure 2 shows a typical North American dial plan.  From an
   application perspective, users expect a seven-digit number to respond
   quickly, not waiting the typical inter-digit critical timer (usually
   four seconds).  Conversely, the user does not want the system to cut
   off their ten-digit number at seven digits because they did not enter
   the number fast enough.

   One approach to this problem is to have an explicit dial string
   terminator.  Often, it is the pound key (#).  Now, consider the
   following snippet.




<span class="grey">Burger &amp; Dolly              Standards Track                     [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   &lt;regex&gt;x{7}#&lt;/regex&gt;
   &lt;regex&gt;x{10}#&lt;/regex&gt;

                   Figure 3: Timeout Matching with Enter

   The problem with the approach in Figure 3 is that the "#" will appear
   in the returned dial string.  Moreover, one often wants to allow the
   user to enter the string without the dial string termination key.  In
   addition, using explicit matching on the key means one has to double
   the number of patterns, e.g., "x{7}", "x{7}#", "x{10}", and "x{10}#".

   The approach used in KPML is to have an explicit "Enter Key", as
   shown in the following snippet.

   &lt;pattern enterkey="#"&gt;
     &lt;regex&gt;x{7}&lt;/regex&gt;
     &lt;regex&gt;x{10}&lt;/regex&gt;
   &lt;/pattern&gt;

                 Figure 4: Timeout Matching with Enter Key

   In Figure 4, the enterkey attribute to the &lt;pattern&gt; tag specifies a
   string that terminates a pattern.  In this situation, if the user
   enters seven digits followed by the "#" key, the pattern matches (or
   fails) immediately.  KPML indicates a terminated nomatch with a KPML
   status code 402.

      NOTE: The enterkey is a string.  The enterkey can be a sequence of
      key presses, such as "**".

   Some patterns look for long-duration key presses.  For example, some
   applications look for long "#" or long "*".

   KPML uses the "L" modifier to &lt;regex&gt; characters to indicate long key
   presses.  The following KPML document looks for a long pound of at
   least 3 seconds.















<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-request xmlns="urn:ietf:params:xml:ns:kpml-request"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-request kpml-request.xsd"
         version="1.0"&gt;
     &lt;pattern long="3000"&gt;
       &lt;regex&gt;L#&lt;/regex&gt;
     &lt;/pattern&gt;
   &lt;/kpml-request&gt;

                                Long Pound

   The request can specify what constitutes "long" by setting the long
   attribute to the &lt;pattern&gt;.  This attribute is an integer
   representing the number of milliseconds.  If the user presses a key
   for longer than "long" milliseconds, the Long modifier is true.  The
   default length of the long attribute is 2500 milliseconds.

   User Interfaces MUST distinguish between long and short input when
   the KPML document specifies both in a document.  However, if there is
   not a corresponding long key press pattern in a document, the User
   Interface MUST match the key press pattern irrespective of the length
   of time the user presses the key.

   As an example, in the following snippet in Figure 6, the User
   Interface discriminates between a long "*" and a normal "*", but any
   length "#" will match the pattern.

   &lt;pattern&gt;
     &lt;regex tag="short_star"&gt;*&lt;/regex&gt;
     &lt;regex tag="long_star"&gt;L*&lt;/regex&gt;
     &lt;regex&gt;#&lt;/regex&gt;
   &lt;/pattern&gt;

                     Figure 6: Long and Short Matching

   Some User Interfaces are unable to present long key presses.  An
   example is an old private branch exchange (PBX) phone set that emits
   fixed-length tones when the user presses a key.  To address this
   issue, the User Interface MAY interpret a succession of presses of a
   single key to be equivalent to a long key press of the same key.  The
   Application indicates it wants this behavior by setting the
   "longrepeat" attribute to the &lt;pattern&gt; to "true".

   The KPML document specifies if the patterns are to be persistent by
   setting the "persist" attribute to the &lt;pattern&gt; tag to "persist" or
   "single-notify".  Any other value, including "one-shot", indicates



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   the request is a one-shot subscription.  If the User Interface does
   not support persistent subscriptions, it returns a KPML document with
   the KPML status code set to 531.  If there are digits in the buffer
   and the digits match an expression in the KPML document, the User
   Interface emits the appropriate kpml notification.

   Note the values of the "persist" attribute are case sensitive.

   Some User Interfaces may support multiple regular expressions in a
   given pattern request.  In this situation, the application may wish
   to know which pattern triggered the event.

   KPML provides a "tag" attribute to the &lt;regex&gt; tag.  The "tag" is an
   opaque string that the User Interface sends back in the notification
   report upon a match in the digit map.  In the case of multiple
   matches, the User Interface MUST choose the longest match in the KPML
   document.  If multiple matches match the same length, the User
   Interface MUST choose the first expression listed in the subscription
   KPML document based on KPML document order.

   If the User Interface cannot support multiple regular expressions in
   a pattern request, the User Interface MUST return a KPML document
   with the KPML status code set to 532.  If the User Interface cannot
   support the number of regular expressions in the pattern request, the
   User Interface MUST return a KPML document with the KPML status code
   set to 534.

      NOTE: We could mandate a minimum number of regular expressions
      that a User Interface must support per subscription request and
      globally.  However, such minimums tend to become designed-in,
      hard-coded limits.  For guidance, one should be able to easily
      handle tens of expressions per subscription and thousands
      globally.  A good implementation should have effectively no
      limits.  That said, to counter possible denial-of-service attacks,
      implementers of User Interfaces should be aware of the 534 and 501
      status codes and feel free to use them.

<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>.  Digit Suppression</span>

   Under basic operation, a KPML User Interface will transmit in-band
   tones (<a href="./rfc2833">RFC 2833</a> [<a href="#ref-10" title="&quot;RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals&quot;">10</a>] or actual tone) in parallel with User Input
   reporting.

      NOTE: If KPML did not have this behavior, then a User Interface
      executing KPML could easily break called applications.  For
      example, take a personal assistant that uses "*9" for attention.
      If the user presses the "*" key, KPML will hold the digit, looking
      for the "9".  What if the user just enters a "*" key, possibly



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


      because they accessed an interactive voice response (IVR) system
      that looks for "*"?  In this case, the "*" would get held by the
      User Interface, because it is looking for the "*9" pattern.  The
      user would probably press the "*" key again, hoping that the
      called IVR system just did not hear the key press.  At that point,
      the User Interface would send both "*" entries, as "**" does not
      match "*9".  However, that would not have the effect the user
      intended when they pressed "*".

   On the other hand, there are situations where passing through tones
   in-band is not desirable.  Such situations include call centers that
   use in-band tone spills to initiate a transfer.

   For those situations, KPML adds a suppression tag, "pre", to the
   &lt;regex&gt; tag.  There MUST NOT be more than one &lt;pre&gt; tag in any given
   &lt;regex&gt; tag.

   If there is only a single &lt;pattern&gt; and a single &lt;regex&gt;, suppression
   processing is straightforward.  The end-point passes User Input until
   the stream matches the regular expression &lt;pre&gt;.  At that point, the
   User Interface will continue collecting User Input, but will suppress
   the generation or pass-through of any in-band User Input.

   If the User Interface suppressed stimulus, it MUST indicate this by
   including the attribute "suppressed" with a value of "true" in the
   notification.

   Clearly, if the User Interface is processing the KPML document
   against buffered User Input, it is too late to suppress the
   transmission of the User Input, as the User Interface has long sent
   the stimulus.  This is a situation where there is a &lt;pre&gt;
   specification, but the "suppressed" attribute will not be "true" in
   the notification.  If there is a &lt;pre&gt; tag that the User Interface
   matched and the User Interface is unable to suppress the User Input,
   it MUST set the "suppressed" attribute to "false".

   A KPML User Interface MAY perform suppression.  If it is not capable
   of suppression, it ignores the suppression attribute.  It MUST set
   the "suppressed" attribute to "false".  In this case, the pattern to
   match is the concatenated pattern of pre+value.

   At some point in time, the User Interface will collect enough User
   Input to the point it matches a &lt;pre&gt; pattern.  The interdigittimer
   attribute indicates how long to wait for the user to enter stimulus
   before reporting a time-out error.  If the interdigittimer expires,
   the User Interface MUST issue a time-out report, transmit the
   suppressed User Input on the media stream, and stop suppression.




<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Once the User Interface detects a match and it sends a NOTIFY request
   to report the User Input, the User Interface MUST stop suppression.
   Clearly, if subsequent User Input matches another &lt;pre&gt; expression,
   then the User Interface MUST start suppression.

   After suppression begins, it may become clear that a match will not
   occur.  For example, take the expression

   &lt;regex&gt;&lt;pre&gt;*8&lt;/pre&gt;xxx[2-9]xxxxxx&lt;/regex&gt;

   At the point the User Interface receives "*8", it will stop
   forwarding stimulus.  Let us say that the next three digits are
   "408".  If the next digit is a zero or one, the pattern will not
   match.

      NOTE: It is critically important for the User Interface to have a
      sensible inter-digit timer.  This is because an errant dot (".")
      may suppress digit sending forever.

   Applications should be very careful to indicate suppression only when
   they are fairly sure the user will enter a digit string that will
   match the regular expression.  In addition, applications should deal
   with situations such as no-match or time-out.  This is because the
   User Interface will hold digits, which will have obvious User
   Interface issues in the case of a failure.

<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>.  User Input Buffer Behavior</span>

   User Interfaces MUST buffer User Input upon receipt of an
   authenticated and accepted subscription.  Subsequent KPML documents
   apply their patterns against the buffered User Input.  Some
   applications use modal interfaces where the first few key presses
   determine what the following key presses mean.  For a novice user,
   the application may play a prompt describing what mode the
   application is in.  However, "power users" often barge through the
   prompt.

   User Interfaces MUST NOT provide a subscriber with digits that were
   detected prior to the authentication and authorization of that
   subscriber.  Without prohibition, a subscriber might be able to gain
   access to calling card or other information that predated the
   subscriber's participation in the call.  Note that this prohibition
   MUST be applied on a per-subscription basis.

   KPML provides a &lt;flush&gt; tag in the &lt;pattern&gt; element.  The default is
   not to flush User Input.  Flushing User Input has the effect of
   ignoring key presses entered before the installation of the KPML
   subscription.  To flush User Input, include the tag



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   &lt;flush&gt;yes&lt;/flush&gt; in the KPML subscription document.  Note that this
   directive affects only the current subscription dialog/id
   combination.

   Lock-step processing of User Input is where the User Interface issues
   a notification, the Application processes the notification while the
   User Interface buffers additional User Input, the Application
   requests more User Input, and only then does the User Interface
   notify the Application based on the collected User Input.  To direct
   the User Interface to operate in lock-step mode, set the &lt;pattern&gt;
   attribute persist="single-notify".

   The User Interface MUST be able to process &lt;flush&gt;no&lt;/flush&gt;.  This
   directive is effectively a no-op.

   Other string values for &lt;flush&gt; may be defined in the future.  If the
   User Interface receives a string it does not understand, it MUST
   treat the string as a no-op.

   If the user presses a key that cannot match any pattern within a
   &lt;regex&gt; tag, the User Interface MUST discard all buffered key presses
   up to and including the current key press from consideration against
   the current or future KPML documents on a given dialog.  However, as
   described above, once there is a match, the User Interface buffers
   any key presses the user entered subsequent to the match.

      NOTE: This behavior allows applications to receive only User Input
      that is of interest to them.  For example, a pre-paid application
      only wishes to monitor for a long pound.  If the user enters other
      stimulus, presumably for other applications, the pre-paid
      application does not want notification of that User Input.  This
      feature is fundamentally different than the behavior of Time
      Division Multiplexer (TDM)-based equipment where every application
      receives every key press.

   To limit reports to only complete matches, set the "nopartial"
   attribute to the &lt;pattern&gt; tag to "true".  In this case, the User
   Interface attempts to match a rolling window over the collected User
   input.

   KPML subscriptions are independent.  Thus, it is not possible for the
   current document to know if a following document will enable barging
   or want User Input flushed.  Therefore, the User Interface MUST
   buffer all User Input, subject to the forced_flush caveat described
   below.






<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   On a given SUBSCRIBE dialog with a given id, the User Interface MUST
   buffer all User Input detected between the time of the report and the
   receipt of the next document, if any.  If the next document indicates
   a buffer flush, then the interpreter MUST flush all collected User
   Input from consideration from KPML documents received on that dialog
   with the given event id.  If the next document does not indicate
   flushing the buffered User Input, then the interpreter MUST apply the
   collected User Input (if possible) against the digit maps presented
   by the script's &lt;regex&gt; tags.  If there is a match, the interpreter
   MUST follow the procedures in <a href="#section-5.3">Section 5.3</a>.  If there is no match, the
   interpreter MUST flush all of the collected User Input.

   Given the potential for needing an infinite buffer for User Input,
   the User Interface MAY discard the oldest User Input from the buffer.
   If the User Interface discards digits, when the User Interface issues
   a KPML notification, it MUST set the forced_flush attribute of the
   &lt;response&gt; tag to "true".  For future use, the Application MUST
   consider any non-null value, other than "false", that it does not
   understand to be the same as "true".

      NOTE: The requirement to buffer all User Input for the entire
      length of the session is not onerous under normal operation.  For
      example, if one has a gateway with 8,000 sessions, and the gateway
      buffers 50 key presses on each session, the requirement is only
      400,000 bytes, assuming one byte per key press.

   Unless there is a suppress indicator in the digit map, it is not
   possible to know if the User Input is for local KPML processing or
   for other recipients of the media stream.  Thus, in the absence of a
   suppression indicator, the User Interface transmits the User Input to
   the far end in real time, using either <a href="./rfc2833">RFC 2833</a>, generating the
   appropriate tones, or both.

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

<span class="h4"><a class="selflink" id="section-3.6.1" href="#section-3.6.1">3.6.1</a>.  Overview</span>

   This subsection is informative in nature.

   The Digit REGular EXpression (DRegex) syntax is a telephony-oriented
   mapping of POSIX Extended Regular Expressions (ERE) [<a href="#ref-13" title="&quot;Information Technology - Portable Operating System Interface (POSIX) - Part 1: Base Definitions, Chapter 9&quot;">13</a>].

   KPML does not use full POSIX ERE for the following reasons.

   o  KPML will often run on high density or extremely low power and
      memory footprint devices.





<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   o  Telephony application convention uses the star symbol ("*") for
      the star key and "x" for any digit 0-9.  Requiring the developer
      to escape the star ("\*") and expand the "x" ("[0-9]") is error
      prone.  This also leads DRegex to use the dot (".") to indicate
      repetition, which was the function of the unadorned star in POSIX
      ERE.

   o  Implementation experience with MGCP [<a href="#ref-11" title="&quot;Media Gateway Control Protocol (MGCP) Version 1.0&quot;">11</a>] and H.248.1 [<a href="#ref-12" title="&quot;Gateway Control Protocol Version 1&quot;">12</a>] has been
      that implementers and users have a hard time understanding the
      precedence of the alternation operator ("|").  This is due both to
      an under-specification of the operator in those documents and
      conceptual problems for users.  Thus, the SIPPING Working Group
      concluded that DRegex should not support alternation.  That said,
      each KPML &lt;pattern&gt; element may contain multiple regular
      expressions (&lt;regex&gt; elements).  Thus, it is straightforward to
      have pattern alternatives (use multiple &lt;regex&gt; elements) without
      the problems associated with the alternation operator ("|").
      Thus, DRegex does not support the POSIX alternation operator.

   o  DRegex includes character classes (characters enclosed in square
      brackets).  However, the negation operator inside a character
      class only operates on numbers.  That is, a negation class
      implicitly includes A-D, *, and #.  Including A-D, *, and # in a
      negation operator is a no-op.  Those familiar with POSIX would
      expect negation of the digits 4 and 5 (e.g., "[^45]") to include
      all other characters (including A-D, R, *, and #), while those
      familiar with telephony digit maps would expect negation to
      implicitly exclude non-digit characters.  Since the complete
      character set of DRegex is very small, constructing a negation
      class using A-D, R, *, and # requires the user to specify the
      positive inverse mapping.  For example, to specify all key
      presses, including A-D and *, except #, the specification would be
      "[0-9A-D*]" instead of "[^#R]".

   The following table shows the mapping from DRegex to POSIX ERE.

                          +--------+-----------+
                          | DRegex | POSIX ERE |
                          +--------+-----------+
                          | *      | \*        |
                          | .      | *         |
                          | x      | [0-9]     |
                          | [xc]   | [0-9c]    |
                          +--------+-----------+

                   Table 1: DRegex to POSIX ERE Mapping





<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   The first substitution, which replaces a star for an escaped star, is
   because telephony application designers are used to using the star
   for the (very common) star key.  Requiring an escape sequence for
   this common pattern would be error prone.  In addition, the usage
   found in DRegex is the same as found in MGCP [<a href="#ref-11" title="&quot;Media Gateway Control Protocol (MGCP) Version 1.0&quot;">11</a>] and H.248.1 [<a href="#ref-12" title="&quot;Gateway Control Protocol Version 1&quot;">12</a>].

   Likewise, the use of the dot instead of star is common usage from
   MGCP and H.248.1, and reusing the star in this context would also be
   confusing and error prone.

   The "x" character is a common indicator of the digits 0 through 9.
   We use it here, continuing the convention.  Clearly, for the case
   "[xc]", where c is any character, the substitution is not a blind
   replacement of "[0-9]" for "x", as that would result in "[[0-9]c]",
   which is not a legal POSIX ERE.  Rather, the substitution for "[xc]"
   is "[0-9c]".

      NOTE: "x" does not include the characters *, #, R, or A through D.

   Users need to take care not to confuse the DRegex syntax with POSIX
   EREs.  They are NOT identical.  In particular, there are many
   features of POSIX EREs that DRegex does not support.

   As an implementation note, if one makes the substitutions described
   in the above table, then a standard POSIX ERE engine can parse the
   digit string.  However, the mapping does not work in the reverse
   (POSIX ERE to DRegex) direction.  DRegex only implements the
   normative behavior described below.

<span class="h4"><a class="selflink" id="section-3.6.2" href="#section-3.6.2">3.6.2</a>.  Operation</span>

   White space is removed before parsing DRegex.  This enables sensible
   pretty printing in XML without affecting the meaning of the DRegex
   string.

   The following rules demonstrate the use of DRegex in KPML.















<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   +---------+---------------------------------------------------------+
   | Entity  | Matches                                                 |
   +---------+---------------------------------------------------------+
   | c       | digits 0-9, *, #, R, and A-D (case insensitive)         |
   | *       | the * character                                         |
   | #       | the # character                                         |
   | R       | The R (Register Recall) key                             |
   | [c]     | Any character in selector                               |
   | [^d]    | Any digit (0-9) not in selector                         |
   | [r1-r2] | Any character in range from r1 to r2, inclusive         |
   | x       | Any digit 0-9                                           |
   | {m}     | m repetitions of previous pattern                       |
   | {m,}    | m or more repetitions of previous pattern               |
   | {,n}    | At most n (including zero) repetitions of previous      |
   |         | pattern                                                 |
   | {m,n}   | At least m and at most n repetitions of previous        |
   |         | pattern                                                 |
   | Lc      | Match the character c if it is "long"; c is a digit 0-9 |
   |         | and A-D, #, or *.                                       |
   +---------+---------------------------------------------------------+

                              DRegex Entities

   For ranges, the A-D characters are disjoint from the 0-9 characters.
   If the device does not have an "R" key, the device MAY report a hook
   flash as an R character.

       +--------------+--------------------------------------------+
       | Example      | Description                                |
       +--------------+--------------------------------------------+
       | 1            | Matches the digit 1                        |
       | [179]        | Matches 1, 7, or 9                         |
       | [2-9]        | Matches 2, 3, 4, 5, 6, 7, 8, 9             |
       | [^15]        | Matches 0, 2, 3, 4, 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       |
       | *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                                  |
       +--------------+--------------------------------------------+

                              DRegex Examples








<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


<span class="h3"><a class="selflink" id="section-3.7" href="#section-3.7">3.7</a>.  Monitoring Direction</span>

   SIP identifies dialogs by their dialog identifier.  The dialog
   identifier is the remote-tag, local-tag, and Call-ID entities defined
   in <a href="./rfc3261">RFC 3261</a> [<a href="#ref-4" title="&quot;SIP: Session Initiation Protocol&quot;">4</a>].

   One method of determining the dialog identifier, particularly for
   third-party applications, is the SIP Dialog Package [<a href="#ref-17" title="&quot;An INVITE- Initiated Dialog Event Package for the Session Initiation Protocol (SIP)&quot;">17</a>].

   For most situations, such as a monaural point-to-point call with a
   single codec, the stream to monitor is obvious.  In such situations
   the Application need not specify which stream to monitor.

   But there may be ambiguity in specifying only the SIP dialog to
   monitor.  The dialog may specify multiple SDP streams that could
   carry key press events.  For example, a dialog may have multiple
   audio streams.  Wherever possible, the User Interface MAY apply local
   policy to disambiguate which stream or streams to monitor.  In order
   to have an extensible mechanism for identifying streams, the
   mechanism for specifying streams is as an element content to the
   &lt;stream&gt; tag.  The only content defined today is the
   &lt;stream&gt;reverse&lt;/stream&gt; tag.

   By default, the User Interface monitors key presses emanating from
   the User Interface.  Given a dialog identifier of Call-ID, local-tag,
   and remote-tag, the User Interface monitors the key presses
   associated with the local-tag.

   In the media proxy case, and potentially other cases, there is a need
   to monitor the key presses arriving from the remote user agent.  The
   optional &lt;stream&gt; element to the &lt;request&gt; tag specifies which stream
   to monitor.  The only legal value is "reverse", which means to
   monitor the stream associated with the remote-tag.  The User
   Interface MUST ignore other values.

      NOTE: The reason this is a tag is so individual stream selection,
      if needed, can be addressed in a backwards-compatible way.
      Further specification of the stream to monitor is the subject of
      future standardization.

<span class="h3"><a class="selflink" id="section-3.8" href="#section-3.8">3.8</a>.  Multiple Simultaneous Subscriptions</span>

   An Application MAY register multiple User Input patterns in a single
   KPML subscription.  If the User Interface supports multiple,
   simultaneous KPML subscriptions, the Application installs the
   subscriptions either in a new SUBSCRIBE-initiated dialog or on an
   existing SUBSCRIBE-initiated dialog with a new event id tag.  If the
   User Interface does not support multiple, simultaneous KPML



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   subscriptions, the User Interface MUST respond with an appropriate
   KPML status code.

   Some User Interfaces may support multiple key press event
   notification subscriptions at the same time.  In this situation, the
   User Interface honors each subscription individually and
   independently.

   A SIP user agent may request multiple subscriptions on the same
   SUBSCRIBE dialog, using the id parameter to the kpml event request.

   One or more SIP user agents may request independent subscriptions on
   different SIP dialogs, although reusing the same dialog for multiple
   subscriptions is NOT RECOMMENDED.

   If the User Interface does not support multiple, simultaneous
   subscriptions, the User Interface MUST return a KPML document with
   the KPML status code set to 533 on the dialog that requested the
   second subscription.  The User Interface MUST NOT modify the state of
   the first subscription on account of the second subscription attempt.

<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>.  Event Package Formal Definition</span>

<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>.  Event Package Name</span>

   This document defines a SIP Event Package as defined in <a href="./rfc3265">RFC 3265</a> [<a href="#ref-5" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">5</a>].
   The event-package token name for this package is:

           "kpml"

<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>.  Event Package Parameters</span>

   This package defines three Event Package parameters: call-id, remote-
   tag, and local-tag.  These parameters MUST be present, to identify
   the subscription dialog.  The User Interface matches the local-tag
   against the to tag, the remote-tag against the from tag, and the
   call-id against the Call-ID.

   The ABNF for these parameters is below.  It refers to many
   constructions from the ABNF of <a href="./rfc3261">RFC 3261</a>, such as EQUAL, DQUOTE, and
   token.

   call-id     =  "call-id" EQUAL ( token / DQUOTE callid DQUOTE )
                    ;; NOTE: any DQUOTEs inside callid MUST be escaped!
   remote-tag  =  "remote-tag" EQUAL token
   local-tag   =  "local-tag" EQUAL token





<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   If any call-ids contain embedded double-quotes, those double-quotes
   MUST be escaped using the backslash-quoting mechanism.  Note that the
   call-id parameter may need to be expressed as a quoted string.  This
   is because the ABNF for the callid production and the word
   production, which is used by callid (both from <a href="./rfc3261">RFC 3261</a> [<a href="#ref-1" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">1</a>]), allow
   some characters (such as "@", "[", and ":") that are not allowed
   within a token.

<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>.  SUBSCRIBE Bodies</span>

   Applications using this event package include an application/
   kpml-request+xml body in SUBSCRIBE requests to indicate which digit
   patterns they are interested in.  The syntax of this body type is
   formally described in <a href="#section-5.2">Section 5.2</a>.

<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>.  Subscription Duration</span>

   The subscription lifetime should be longer than the expected call
   time.  Subscriptions to this event package MAY range from minutes to
   weeks.  Subscriptions in hours or days are more typical and are
   RECOMMENDED.  The default subscription duration for this event
   package is 7200 seconds.

      Subscribers MUST be able to handle the User Interface returning an
      Expires value smaller than the requested value.  Per <a href="./rfc3265">RFC 3265</a> [<a href="#ref-5" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">5</a>],
      the subscription duration is the value returned by the Notifier in
      the 200 OK Expires header.

<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>.  NOTIFY Bodies</span>

   NOTIFY requests can contain application/kpml-response+xml (KPML
   Response) bodies.  The syntax of this body type is formally described
   in <a href="#section-5.3">Section 5.3</a>.  NOTIFY requests in immediate response to a SUBSCRIBE
   request MUST NOT contain a body unless they are notifying the
   subscriber of an error condition or previously buffered digits.

   Notifiers MAY send notifications with any format acceptable to the
   subscriber (based on the subscriber's inclusion of these formats in
   an Accept header).  A future extension MAY define other NOTIFY
   bodies.  If no "Accept" header is present in the SUBSCRIBE, the body
   type defined in this document MUST be assumed.

<span class="h3"><a class="selflink" id="section-4.6" href="#section-4.6">4.6</a>.  Subscriber Generation of SUBSCRIBE Requests</span>

   A kpml request document contains a &lt;pattern&gt; element with a series of
   &lt;regex&gt; tags.  Each &lt;regex&gt; element specifies a potential pattern for
   the User Interface to match.  <a href="#section-5.1">Section 5.1</a> describes the DRegex, or
   digit regular expression, language.



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   KPML specifies key press event notification filters.  The MIME type
   for KPML requests is application/kpml-request+xml.

   The KPML request document MUST be well formed and SHOULD be valid.
   KPML documents MUST conform to XML 1.0 [<a href="#ref-14" title="&quot;Extensible Markup Language (XML) 1.0 (Second Edition)&quot;">14</a>] and MUST use UTF-8
   encoding.

   Because of the potentially sensitive nature of the information
   reported by KPML, subscribers SHOULD use sips: and MAY use S/MIME on
   the content.

   Subscribers MUST be prepared for the notifier to insist on
   authentication of the subscription request.  Subscribers MUST be
   prepared for the notifier to insist on using a secure communication
   channel.

<span class="h3"><a class="selflink" id="section-4.7" href="#section-4.7">4.7</a>.  Notifier Processing of SUBSCRIBE Requests</span>

   The user information transported by KPML is potentially sensitive.
   For example, it could include calling card or credit card numbers.
   Thus the User Interface (notifier) MUST authenticate the requesting
   party in some way before accepting the subscription.

   User Interfaces MUST implement SIP Digest authentication as required
   by <a href="./rfc3261">RFC 3261</a> [<a href="#ref-4" title="&quot;SIP: Session Initiation Protocol&quot;">4</a>] and MUST implement the sips: scheme and TLS.

   Upon authenticating the requesting party, the User Interface
   determines if the requesting party has authorization to monitor the
   user's key presses.  The default authorization policy is to allow a
   KPML subscriber who can authenticate with a specific identity to
   monitor key presses from SIP sessions in which the same or equivalent
   authenticated identity is a participant.  In addition, KPML will
   often be used, for example, between "application servers"
   (subscribers) and PSTN gateways (notifiers) operated by the same
   domain or federation of domains.  In this situation a notifier MAY be
   configured with a list of subscribers which are specifically trusted
   and authorized to subscribe to key press information related to all
   sessions in a particular context.

   The User Interface returns a Contact URI that may have GRUU [<a href="#ref-9" title="&quot;Obtaining and Using Globally Routable User Agent (UA) URIs (GRUU) in the Session Initiation Protocol (SIP)&quot;">9</a>]
   properties in the Contact header of a SIP INVITE, 1xx, or 2xx
   response.

   After authorizing the request, the User Interface checks to see if
   the request is to terminate a subscription.  If the request will
   terminate the subscription, the User Interface does the appropriate
   processing, including the procedures described in <a href="#section-5.2">Section 5.2</a>.




<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   If the request has no KPML body, then any KPML document running on
   that dialog and addressed by the event id, if present, immediately
   terminates.  This is a mechanism for unloading a KPML document while
   keeping the SUBSCRIBE-initiated dialog active.  This can be important
   for secure sessions that have high costs for session establishment.
   The User Interface follows the procedures described in <a href="#section-5.2">Section 5.2</a>.

   If the dialog referenced by the kpml subscription does not exist, the
   User Interface follows the procedures in <a href="#section-5.3">Section 5.3</a>.  Note the User
   Interface MUST issue a 200 OK to the SUBSCRIBE request before issuing
   the NOTIFY, as the SUBSCRIBE itself is well formed.

   If the request has a KPML body, the User Interface parses the KPML
   document.  The User Interface SHOULD validate the XML document
   against the schema presented in <a href="#section-5.2">Section 5.2</a>.  If the document is not
   valid, the User Interface rejects the SUBSCRIBE request with an
   appropriate error response and terminates the subscription.  If there
   is a loaded KPML document on the subscription, the User Interface
   unloads the document.

   In addition, if there is a loaded KPML document on the subscription,
   the end device unloads the document.

   Following the semantics of SUBSCRIBE, if the User Interface receives
   a resubscription, the User Interface MUST terminate the existing KPML
   request and replace it with the new request.

   It is possible for the INVITE usage of the dialog to terminate during
   key press collection.  The cases enumerated here are explicit
   subscription termination, automatic subscription termination, and
   underlying (INVITE-initiated) dialog termination.

   If a SUBSCRIBE request has an expires of zero (explicit SUBSCRIBE
   termination), includes a KPML document, and there is buffered User
   Input, then the User Interface attempts to process the buffered
   digits against the document.  If there is a match, the User Interface
   MUST generate the appropriate KPML report with the KPML status code
   of 200.  The SIP NOTIFY body terminates the subscription by setting
   the subscription state to "terminated" and a reason of "timeout".

   If the SUBSCRIBE request has an expires of zero and no KPML body or
   the expires timer on the SUBSCRIBE-initiated dialog fires at the User
   Interface (notifier), then the User Interface MUST issue a KPML
   report with the KPML status code 487, Subscription Expired.  The
   report also includes the User Input collected up to the time the
   expires timer expired or when the subscription with expires equal to
   zero was processed.  This could be the null string.




<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Per the mechanisms of <a href="./rfc3265">RFC 3265</a> [<a href="#ref-5" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">5</a>], the User Interface MUST terminate
   the SIP SUBSCRIBE dialog.  The User Interface does this via the SIP
   NOTIFY body transporting the final report described in the preceding
   paragraph.  In particular, the subscription state will be
   "terminated" and a reason of "timeout".

   Terminating the subscription when a dialog terminates ensures
   reauthorization (if necessary) for attaching to subsequent
   subscriptions.

   If a SUBSCRIBE request references a dialog that is not present at the
   User Interface, the User Interface MUST generate a KPML report with
   the KPML status code 481, Dialog Not Found.  The User Interface
   terminates the subscription by setting the subscription state to
   "terminated".

   If the KPML document is not valid, the User Interface generates a
   KPML report with the KPML status code 501, Bad Document.  The User
   Interface terminates the subscription by setting the subscription
   state to "terminated".

   If the document is valid but the User Interface does not support a
   namespace in the document, the User Interface MUST respond with a
   KPML status code 502, Namespace Not Supported.

<span class="h3"><a class="selflink" id="section-4.8" href="#section-4.8">4.8</a>.  Notifier Generation of NOTIFY Requests</span>

   Immediately after a subscription is accepted, the Notifier MUST send
   a NOTIFY with the current location information as appropriate based
   on the identity of the subscriber.  This allows the Subscriber to
   resynchronize its state.

   The User Interface (notifier in SUBSCRIBE/NOTIFY parlance) generates
   NOTIFY requests based on the requirements of <a href="./rfc3265">RFC 3265</a> [<a href="#ref-5" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">5</a>].
   Specifically, if a SUBSCRIBE request is valid and authorized, it will
   result in an immediate NOTIFY.

   The KPML payload distinguishes between an initial NOTIFY and a NOTIFY
   informing of key presses.  If there is no User Input buffered at the
   time of the SUBSCRIBE (see below) or the buffered User Input does not
   match the new KPML document, then the immediate NOTIFY MUST NOT
   contain a KPML body.  If User Interface has User Input buffered that
   results in a match using the new KPML document, then the NOTIFY MUST
   return the appropriate KPML document.

   The NOTIFY in response to a SUBSCRIBE request has no KPML if there
   are no matching buffered digits.  An example of this is in Figure 10.




<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   If there are buffered digits in the SUBSCRIBE request that match a
   pattern, then the NOTIFY message in response to the SUBSCRIBE request
   MUST include the appropriate KPML document.

   NOTIFY sip:application@example.com SIP/2.0
   Via: SIP/2.0/UDP proxy.example.com
   Max-Forwards: 70
   To: &lt;sip:application@example.com&gt;
   From: &lt;sip:endpoint@example.net&gt;
   Call-Id: 439hu409h4h09903fj0ioij
   Subscription-State: active; expires=7200
   CSeq: 49851 NOTIFY
   Event: kpml

                    Figure 10: Immediate NOTIFY Example

   All subscriptions MUST be authenticated, particularly those that
   match on buffered input.

   KPML specifies the key press notification report format.  The MIME
   type for KPML reports is application/kpml-response+xml.  The default
   MIME type for the kpml event package is application/
   kpml-response+xml.

   If the requestor is not using a secure transport protocol such as TLS
   for every hop (e.g., by using a sips: URI), the User Interface SHOULD
   use S/MIME to protect the user information in responses.

   When the user enters key presses that match a &lt;regex&gt; tag, the User
   Interface will issue a report.

   After reporting, the interpreter terminates the KPML session unless
   the subscription has a persistence indicator.  If the subscription
   does not have a persistence indicator, the User Interface MUST set
   the state of the subscription to "terminated" in the NOTIFY report.

   If the subscription does not have a persistence indicator, to collect
   more digits, the requestor must issue a new request.

      NOTE: This highlights the "one shot" nature of KPML, reflecting
      the balance of features and ease of implementing an interpreter.

   KPML reports have two mandatory attributes, code and text.  These
   attributes describe the state of the KPML interpreter on the User
   Interface.  Note the KPML status code is not necessarily related to
   the SIP result code.  An important example of this is where a legal
   SIP subscription request gets a normal SIP 200 OK followed by a
   NOTIFY, but there is something wrong with the KPML request.  In this



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   case, the NOTIFY would include the KPML status code in the KPML
   report.  Note that from a SIP perspective, the SUBSCRIBE and NOTIFY
   were successful.  Also, if the KPML failure is not recoverable, the
   User Interface will most likely set the Subscription-State to
   "terminated".  This lets the SIP machinery know the subscription is
   no longer active.

   If a pattern matches, the User Interface will emit a KPML report.
   Since this is a success report, the code is "200", and the text is
   "OK".

   The KPML report includes the actual digits matched in the digit
   attribute.  The digit string uses the conventional characters '*' and
   '#' for star and octothorpe, respectively.  The KPML report also
   includes the tag attribute if the regex that matched the digits had a
   tag attribute.

   If the subscription requested digit suppression and the User
   Interface suppressed digits, the suppressed attribute indicates
   "true".  The default value of suppressed is "false".

      NOTE: KPML does not include a timestamp.  There are a number of
      reasons for this.  First, what timestamp would it include?  Would
      it be the time of the first detected key press?  The time the
      interpreter collected the entire string?  A range?  Second, if the
      RTP timestamp is a datum of interest, why not simply get RTP in
      the first place?  That all said, if it is really compelling to
      have the timestamp in the response, it could be an attribute to
      the &lt;response&gt; tag.

   Note that if the monitored (INVITE-initiated) dialog terminates, the
   notifier still MUST explicitly terminate the KPML subscriptions
   monitoring that dialog.

<span class="h3"><a class="selflink" id="section-4.9" href="#section-4.9">4.9</a>.  Subscriber Processing of NOTIFY Requests</span>

   If there is no KPML body, it means the SUBSCRIBE was successful.
   This establishes the dialog if there is no buffered User Input to
   report.

   If there is a KPML document, and the KPML status code is 200, then a
   match occurred.

   If there is a KPML document, and the KPML status code is between 400
   and 499, then an error occurred with User Input collection.  The most
   likely cause is a timeout condition.





<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   If there is a KPML document, and the KPML status code is between 500
   and 599, then an error occurred with the subscription.  See <a href="#section-6">Section 6</a>
   for more on the meaning of KPML status codes.

   The subscriber MUST be mindful of the subscription state.  The User
   Interface may terminate the subscription at any time.

<span class="h3"><a class="selflink" id="section-4.10" href="#section-4.10">4.10</a>.  Handling of Forked Requests</span>

   Forked requests are NOT ALLOWED for this event type.  This can be
   ensured if the Subscriptions to this event package are sent to SIP
   URIs that have GRUU properties.

<span class="h3"><a class="selflink" id="section-4.11" href="#section-4.11">4.11</a>.  Rate of Notifications</span>

   The User Interface MUST NOT generate messages faster than 25 messages
   per second, or one message every 40 milliseconds.  This is the
   minimum time period for MF digit spills.  Even 30-millisecond DTMF,
   as one sometimes finds in Japan, has a 20-millisecond off time,
   resulting in a 50-millisecond interdigit time.  This document
   strongly RECOMMENDS AGAINST using KPML for digit-by-digit messaging,
   such as would be the case if the only &lt;regex&gt; is "x".

   The sustained rate of notification shall be no more than 100 Notifies
   per minute.

   The User Interface MUST reliably deliver notifications.  Because
   there is no meaningful metric for throttling requests, the User
   Interface SHOULD send NOTIFY messages over a congestion-controlled
   transport, such as TCP.

      Note that all SIP implementations are already required to
      implement SIP over TCP.

<span class="h3"><a class="selflink" id="section-4.12" href="#section-4.12">4.12</a>.  State Agents and Lists</span>

   KPML requests are sent to a specific SIP URI, which may have GRUU
   properties, and they attempt to monitor a specific stream that
   corresponds with a specific target dialog.  Consequently,
   implementers MUST NOT define state agents for this event package or
   allow subscriptions for this event package to resource lists using
   the event list extension [<a href="#ref-18" title="&quot;A Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists&quot;">18</a>].









<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


<span class="h3"><a class="selflink" id="section-4.13" href="#section-4.13">4.13</a>.  Behavior of a Proxy Server</span>

   There are no additional requirements on a SIP Proxy, other than to
   transparently forward the SUBSCRIBE and NOTIFY methods as required in
   SIP.

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

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

   The following definition follows <a href="./rfc4234">RFC 4234</a> [<a href="#ref-2" title="&quot;Augmented BNF for Syntax Specifications: ABNF&quot;">2</a>].  The definition of
   DIGIT is from <a href="./rfc4234">RFC 4234</a>, namely, the characters "0" through "9".  Note
   the DRegexCharacter is not a HEXDIG from <a href="./rfc4234">RFC 4234</a>.  In particular,
   DRegexCharacter includes neither "E" nor "F".  Note that
   DRegexCharacter is case insensitive.

   DRegex           = 1*( DRegexPosition [ RepeatCount ] )
   DRegexPosition   = DRegexSymbol / DRegexSet
   DRegexSymbol     = [ "L" ] DRegexCharacter
   DRegexSet        = "[" 1*DRegexSetList "]"
   DRegexSetList    = DRegexCharacter [ "-" DRegexCharacter ]
   DRegexCharacter  = DIGIT / "A" / "B" / "C" / "D" / "R" / "*" / "#" /
                            "a" / "b" / "c" / "d" / "r"
   RepeatCount      = "." / "{" RepeatRange "}"
   RepeatRange      = Count / ( Count "," Count ) /
                              ( Count "," ) / ( "," Count )
   Count            = 1*DIGIT

                              ABNF for DRegex

   Note that future extensions to this document may introduce other
   characters for DRegexCharacter, in the scheme of H.248.1 [<a href="#ref-12" title="&quot;Gateway Control Protocol Version 1&quot;">12</a>] or
   possibly as named strings or XML namespaces.


















<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>.  KPML Request</span>

   The following syntax for KPML requests uses the XML Schema [<a href="#ref-8" title="&quot;XML Schema Part 1: Structures&quot;">8</a>].

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;xs:schema targetNamespace="urn:ietf:params:xml:ns:kpml-request"
    xmlns="urn:ietf:params:xml:ns:kpml-request"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    elementFormDefault="qualified"
    attributeFormDefault="unqualified"&gt;
     &lt;xs:element name="kpml-request"&gt;
       &lt;xs:annotation&gt;
         &lt;xs:documentation&gt;IETF Keypad Markup Language Request
         &lt;/xs:documentation&gt;
       &lt;/xs:annotation&gt;
       &lt;xs:complexType&gt;
         &lt;xs:sequence&gt;
           &lt;xs:element name="stream" minOccurs="0"&gt;
             &lt;xs:complexType&gt;
               &lt;xs:choice&gt;
                 &lt;xs:element name="reverse" minOccurs="0"/&gt;
                 &lt;xs:any namespace="##other"/&gt;
               &lt;/xs:choice&gt;
             &lt;/xs:complexType&gt;
           &lt;/xs:element&gt;
           &lt;xs:element name="pattern"&gt;
             &lt;xs:complexType&gt;
               &lt;xs:sequence&gt;
                 &lt;xs:element name="flush" minOccurs="0"&gt;
                   &lt;xs:annotation&gt;
                     &lt;xs:documentation&gt;
                       Default is to not flush buffer
                     &lt;/xs:documentation&gt;
                   &lt;/xs:annotation&gt;
                   &lt;xs:complexType&gt;
                     &lt;xs:simpleContent&gt;
                       &lt;xs:extension base="xs:string"/&gt;
                     &lt;/xs:simpleContent&gt;
                   &lt;/xs:complexType&gt;
                 &lt;/xs:element&gt;
                 &lt;xs:element name="regex" maxOccurs="unbounded"&gt;
                   &lt;xs:annotation&gt;
                     &lt;xs:documentation&gt;
                       Key press notation is a string to allow
                       for future extension of non-16 digit
                       keypads or named keys
                     &lt;/xs:documentation&gt;
                   &lt;/xs:annotation&gt;



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


                   &lt;xs:complexType mixed="true"&gt;
                     &lt;xs:choice&gt;
                       &lt;xs:element name="pre" minOccurs="0"&gt;
                         &lt;xs:complexType&gt;
                           &lt;xs:simpleContent&gt;
                             &lt;xs:extension base="xs:string"/&gt;
                           &lt;/xs:simpleContent&gt;
                         &lt;/xs:complexType&gt;
                       &lt;/xs:element&gt;
                       &lt;xs:any namespace="##other"/&gt;
                     &lt;/xs:choice&gt;
                     &lt;xs:attribute name="tag" type="xs:string"
                                   use="optional"/&gt;
                   &lt;/xs:complexType&gt;
                 &lt;/xs:element&gt;
               &lt;/xs:sequence&gt;
               &lt;xs:attribute name="persist" use="optional"&gt;
                 &lt;xs:annotation&gt;
                   &lt;xs:documentation&gt;Default is "one-shot"
                   &lt;/xs:documentation&gt;
                 &lt;/xs:annotation&gt;
                 &lt;xs:simpleType&gt;
                   &lt;xs:restriction base="xs:string"&gt;
                     &lt;xs:enumeration value="one-shot"/&gt;
                     &lt;xs:enumeration value="persist"/&gt;
                     &lt;xs:enumeration value="single-notify"/&gt;
                   &lt;/xs:restriction&gt;
                 &lt;/xs:simpleType&gt;
               &lt;/xs:attribute&gt;
               &lt;xs:attribute name="interdigittimer"
                             type="xs:integer"
                             use="optional"&gt;
                 &lt;xs:annotation&gt;
                   &lt;xs:documentation&gt;Default is 4000 (ms)
                   &lt;/xs:documentation&gt;
                 &lt;/xs:annotation&gt;
               &lt;/xs:attribute&gt;
               &lt;xs:attribute name="criticaldigittimer"
                             type="xs:integer"
                             use="optional"&gt;
                 &lt;xs:annotation&gt;
                   &lt;xs:documentation&gt;Default is 1000 (ms)
                   &lt;/xs:documentation&gt;
                 &lt;/xs:annotation&gt;
               &lt;/xs:attribute&gt;
               &lt;xs:attribute name="extradigittimer"
                             type="xs:integer"
                             use="optional"&gt;



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


                 &lt;xs:annotation&gt;
                   &lt;xs:documentation&gt;Default is 500 (ms)
                   &lt;/xs:documentation&gt;
                 &lt;/xs:annotation&gt;
               &lt;/xs:attribute&gt;
               &lt;xs:attribute name="long" type="xs:integer"
                             use="optional"/&gt;
               &lt;xs:attribute name="longrepeat" type="xs:boolean"
                             use="optional"/&gt;
               &lt;xs:attribute name="nopartial" type="xs:boolean"
                             use="optional"&gt;
                 &lt;xs:annotation&gt;
                   &lt;xs:documentation&gt;Default is false
                   &lt;/xs:documentation&gt;
                 &lt;/xs:annotation&gt;
               &lt;/xs:attribute&gt;
               &lt;xs:attribute name="enterkey" type="xs:string"
                             use="optional"&gt;
                 &lt;xs:annotation&gt;
                   &lt;xs:documentation&gt;No default enterkey
                   &lt;/xs:documentation&gt;
                 &lt;/xs:annotation&gt;
               &lt;/xs:attribute&gt;
             &lt;/xs:complexType&gt;
           &lt;/xs:element&gt;
         &lt;/xs:sequence&gt;
         &lt;xs:attribute name="version" type="xs:string"
                       use="required"/&gt;
       &lt;/xs:complexType&gt;
     &lt;/xs:element&gt;
   &lt;/xs:schema&gt;

                  Figure 12: XML Schema for KPML Requests


















<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>.  KPML Response</span>

   The following syntax for KPML responses uses the XML Schema [<a href="#ref-8" title="&quot;XML Schema Part 1: Structures&quot;">8</a>].

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;xs:schema targetNamespace="urn:ietf:params:xml:ns:kpml-response"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns="urn:ietf:params:xml:ns:kpml-response"
    elementFormDefault="qualified"
    attributeFormDefault="unqualified"&gt;
     &lt;xs:element name="kpml-response"&gt;
       &lt;xs:annotation&gt;
         &lt;xs:documentation&gt;IETF Keypad Markup Language Response
         &lt;/xs:documentation&gt;
       &lt;/xs:annotation&gt;
       &lt;xs:complexType&gt;
         &lt;xs:attribute name="version" type="xs:string"
                       use="required"/&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="suppressed" type="xs:boolean"
                       use="optional"/&gt;
         &lt;xs:attribute name="forced_flush" type="xs:string"
                       use="optional"&gt;
           &lt;xs:annotation&gt;
             &lt;xs:documentation&gt;
               String for future use for e.g., number of digits lost.
             &lt;/xs:documentation&gt;
           &lt;/xs:annotation&gt;
         &lt;/xs:attribute&gt;
         &lt;xs:attribute name="digits" type="xs:string"
                       use="optional"/&gt;
         &lt;xs:attribute name="tag" type="xs:string" use="optional"&gt;
           &lt;xs:annotation&gt;
             &lt;xs:documentation&gt;Matches tag from regex in request
             &lt;/xs:documentation&gt;
           &lt;/xs:annotation&gt;
         &lt;/xs:attribute&gt;
       &lt;/xs:complexType&gt;
     &lt;/xs:element&gt;
   &lt;/xs:schema&gt;

                       XML Schema for KPML Responses






<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>.  Enumeration of KPML Status Codes</span>

   KPML status codes broadly follow their SIP counterparts.  Codes that
   start with a 2 indicate success.  Codes that start with a 4 indicate
   failure.  Codes that start with a 5 indicate a server failure,
   usually a failure to interpret the document or to support a requested
   feature.

   KPML clients MUST be able to handle arbitrary status codes by
   examining the first digit only.

   Any text can be in a KPML report document.  KPML clients MUST NOT
   interpret the text field.

        +------+--------------------------------------------------+
        | Code | Text                                             |
        +------+--------------------------------------------------+
        | 200  | Success                                          |
        | 402  | User Terminated without Match                    |
        | 423  | Timer Expired                                    |
        | 481  | Dialog Not Found                                 |
        | 487  | Subscription Expired                             |
        | 501  | Bad Document                                     |
        | 502  | Namespace Not Supported                          |
        | 531  | Persistent Subscriptions Not Supported           |
        | 532  | Multiple Regular Expressions Not Supported       |
        | 533  | Multiple Subscriptions on a Dialog Not Supported |
        | 534  | Too Many Regular Expressions                     |
        +------+--------------------------------------------------+

                        Table 4: KPML Status Codes

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

   This document registers a new SIP Event Package, two new MIME types,
   and two new XML namespaces.

<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>.  SIP Event Package Registration</span>

   Package name:  kpml
   Type:  package
   Contact:  Eric Burger, &lt;e.burger@ieee.org&gt;
   Change Controller:  SIPPING Working Group delegated from the IESG
   Published Specification:  <a href="./rfc4730">RFC 4730</a>







<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>.  MIME Media Type application/kpml-request+xml</span>

   MIME media type name:  application
   MIME subtype name:  kpml-request+xml
   Required parameters:  none
   Optional parameters:  Same as charset parameter application/xml as
      specified in XML Media Types [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>]
   Encoding considerations:  See <a href="./rfc3023">RFC 3023</a> [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>].
   Security considerations:  See <a href="./rfc3023#section-10">Section&nbsp;10 of RFC 3023</a> [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>] and
      <a href="./rfc4730#section-8">Section&nbsp;8 of RFC 4730</a>
   Interoperability considerations:  See <a href="./rfc2023">RFC 2023</a> [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>] and <a href="./rfc4730">RFC 4730</a>
   Published specification:  <a href="./rfc4730">RFC 4730</a>
   Applications which use this media type:  Session-oriented
      applications that have primitive User Interfaces.
   Change controller:  SIPPING Working Group delegated from the IESG
   Personal and email address for further information:  Eric Burger
      &lt;e.burger@ieee.org&gt;
   Intended usage:  COMMON

<span class="h3"><a class="selflink" id="section-7.3" href="#section-7.3">7.3</a>.  MIME Media Type application/kpml-response+xml</span>

   MIME media type name:  application
   MIME subtype name:  kpml-response+xml
   Required parameters:  none
   Optional parameters:  Same as charset parameter application/xml as
      specified in XML Media Types [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>]
   Encoding considerations:  See <a href="./rfc3023">RFC 3023</a> [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>].
   Security considerations:  See <a href="./rfc3023#section-10">Section&nbsp;10 of RFC 3023</a> [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>] and
      <a href="./rfc4730#section-8">Section&nbsp;8 of RFC 4730</a>
   Interoperability considerations:  See <a href="./rfc2023">RFC 2023</a> [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>] and <a href="./rfc4730">RFC 4730</a>
   Published specification:  <a href="./rfc4730">RFC 4730</a>
   Applications which use this media type:  Session-oriented
      applications that have primitive User Interfaces.
   Change controller:  SIPPING Working Group delegated from the IESG
   Personal and email address for further information:  Eric Burger
      &lt;e.burger@ieee.org&gt;
   Intended usage:  COMMON

<span class="h3"><a class="selflink" id="section-7.4" href="#section-7.4">7.4</a>.  URN Sub-Namespace Registration for urn:ietf:xml:ns:kpml-request</span>

   URI: urn:ietf:params:xml:ns:kpml-request

   Registrant Contact: The IESG &lt;iesg@ietf.org&gt;








<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   XML:

   &lt;?xml version="1.0"?&gt;
   &lt;!DOCTYPE html PUBLIC "-//W3C/DTD XHTML Basic 1.0//EN"
             "<a href="http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd</a>"&gt;
   &lt;html xmlns="http://www.w3.org/1999/xhtml"&gt;
     &lt;head&gt;
       &lt;meta http-equiv="content-type"
             content="text/html;charset=iso-8859-1"/&gt;
       &lt;title&gt;Key Press Markup Language Request&lt;/title&gt;
     &lt;/head&gt;
     &lt;body&gt;
       &lt;h1&gt;Namespace for Key Press Markup Language Request&lt;/h1&gt;
       &lt;h2&gt;urn:ietf:params:xml:ns:kpml-request&lt;/h2&gt;
       &lt;p&gt;
   &lt;a href="ftp://ftp.rfc-editor.org/in-notes/RFC4730.txt"&gt;<a href="./rfc4730">RFC 4730</a>&lt;/a&gt;.
       &lt;/p&gt;
     &lt;/body&gt;
   &lt;/html&gt;

<span class="h3"><a class="selflink" id="section-7.5" href="#section-7.5">7.5</a>.  URN Sub-Namespace Registration for urn:ietf:xml:ns:kpml-response</span>

   URI: urn:ietf:params:xml:ns:kpml-response

   Registrant Contact: The IESG &lt;iesg@ietf.org&gt;

   XML:

   &lt;?xml version="1.0"?&gt;
   &lt;!DOCTYPE html PUBLIC "-//W3C/DTD XHTML Basic 1.0//EN"
             "<a href="http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd</a>"&gt;
   &lt;html xmlns="http://www.w3.org/1999/xhtml"&gt;
     &lt;head&gt;
       &lt;meta http-equiv="content-type"
             content="text/html;charset=iso-8859-1"/&gt;
       &lt;title&gt;Key Press Markup Language Response&lt;/title&gt;
     &lt;/head&gt;
     &lt;body&gt;
       &lt;h1&gt;Namespace for Key Press Markup Language Response&lt;/h1&gt;
       &lt;h2&gt;urn:ietf:params:xml:ns:kpml-response&lt;/h2&gt;
       &lt;p&gt;
   &lt;a href="ftp://ftp.rfc-editor.org/in-notes/rfc4730.txt"&gt;<a href="./rfc4730">RFC 4730</a>&lt;/a&gt;.
       &lt;/p&gt;
     &lt;/body&gt;
   &lt;/html&gt;






<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


<span class="h3"><a class="selflink" id="section-7.6" href="#section-7.6">7.6</a>.  KPML Request Schema Registration</span>

   Per <a href="./rfc3688">RFC 3688</a> [<a href="#ref-7" title="&quot;The IETF XML Registry&quot;">7</a>], IANA registered the XML Schema for KPML as
   referenced in <a href="./rfc4730#section-5.2">Section&nbsp;5.2 of RFC 4730</a>.

   URI: urn:ietf:params:xml:schema:kpml-request

   Registrant Contact: &lt;iesg@ietf.org&gt;

<span class="h3"><a class="selflink" id="section-7.7" href="#section-7.7">7.7</a>.  KPML Response Schema Registration</span>

   Per <a href="./rfc3688">RFC 3688</a> [<a href="#ref-7" title="&quot;The IETF XML Registry&quot;">7</a>], IANA registered the XML Schema for KPML as
   referenced in <a href="./rfc4730#section-5.3">Section&nbsp;5.3 of RFC 4730</a>.

   URI: urn:ietf:params:xml:schema:kpml-response

   Registrant Contact: IETF, SIPPING Work Group &lt;sipping@ietf.org&gt;, Eric
   Burger &lt;e.burger@ieee.org&gt;.

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

   The user information transported by KPML is potentially sensitive.
   For example, it could include calling card or credit card numbers.
   This potentially private information could be provided accidentally
   if the notifier does not properly authenticate or authorize a
   subscription.  Similarly private information (such as a credit card
   number or calling card number) could be revealed to an otherwise
   legitimate subscriber (one operating an IVR) if digits buffered
   earlier in the session are provided unintentionally to the new
   subscriber.

   Likewise, an eavesdropper could view KPML digit information if it is
   not encrypted, or an attacker could inject fraudulent notifications
   unless the messages or the SIP path over which they travel are
   integrity protected.

   Therefore, User Interfaces MUST NOT downgrade their own security
   policy.  That is, if a User Interface policy is to restrict
   notifications to authenticated and authorized subscribers over secure
   communications, then the User Interface must not accept an
   unauthenticated, unauthorized subscription over an insecure
   communication channel.

   As an XML markup, all of the security considerations of <a href="./rfc3023">RFC 3023</a> [<a href="#ref-3" title="&quot;XML Media Types&quot;">3</a>]
   and <a href="./rfc3406">RFC 3406</a> [<a href="#ref-6" title="&quot;Uniform Resource Names (URN) Namespace Definition Mechanisms&quot;">6</a>] MUST be met.  Pay particular attention to the
   robustness requirements of parsing XML.





<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Key press information is potentially sensitive.  For example, it can
   represent credit card, calling card, or other personal information.
   Hijacking sessions allow unauthorized entities access to this
   sensitive information.  Therefore, signaling SHOULD be secure, e.g.,
   use of TLS and sips: SHOULD be used.  Moreover, the information
   itself is sensitive so S/MIME or other appropriate mechanisms SHOULD
   be used.

   Subscriptions MUST be authenticated in some manner.  As required by
   the core SIP [<a href="#ref-4" title="&quot;SIP: Session Initiation Protocol&quot;">4</a>] specification, all SIP implementations MUST support
   digest authentication.  In addition, User Interfaces MUST implement
   support for the sips: scheme and SIP over TLS.  Subscribers MUST
   expect the User Interface to demand the use of an authentication
   scheme.  If the local policy of a User Interface is to use
   authentication or secure communication channels, the User Interface
   MUST reject subscription requests that do not meet that policy.

   User Interfaces MUST begin buffering User Input upon receipt of an
   authenticated and accepted subscription.  This buffering is done on a
   per-subscription basis.

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

   This section is informative in nature.  If there is a discrepancy
   between this section and the normative sections above, the normative
   sections take precedence.

<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>.  Monitoring for Octothorpe</span>

   A common need for pre-paid and personal assistant applications is to
   monitor a conversation for a signal indicating a change in user focus
   from the party they called through the application to the application
   itself.  For example, if you call a party using a pre-paid calling
   card, and the party you call redirects you to voice mail, digits you
   press are for the voice mail system.  However, many applications have
   a special key sequence, such as the octothorpe (#, or pound sign) or
   *9, that terminate the called party session and shift the user's
   focus to the application.













<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Figure 16 shows the KPML for long octothorpe.

   &lt;?xml version="1.0"?&gt;
   &lt;kpml-request xmlns="urn:ietf:params:xml:ns:kpml-request"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-request kpml-request.xsd"
         version="1.0"&gt;
     &lt;pattern&gt;
       &lt;regex&gt;L#&lt;/regex&gt;
     &lt;/pattern&gt;
   &lt;/kpml-request&gt;

                    Figure 16: Long Octothorpe Example

   The regex value L indicates the following digit needs to be a long-
   duration key press.

<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>.  Dial String Collection</span>

   In this example, the User Interface collects a dial string.  The
   application uses KPML to quickly determine when the user enters a
   target number.  In addition, KPML indicates what type of number the
   user entered.

   &lt;?xml version="1.0"?&gt;
   &lt;kpml-request xmlns="urn:ietf:params:xml:ns:kpml-request"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-request kpml-request.xsd"
         version="1.0"&gt;
     &lt;pattern&gt;
       &lt;regex tag="local-operator"&gt;0&lt;/regex&gt;
       &lt;regex tag="ld-operator"&gt;00&lt;/regex&gt;
       &lt;regex tag="vpn"&gt;7[x][x][x]&lt;/regex&gt;
       &lt;regex tag="local-number7"&gt;9xxxxxxx&lt;/regex&gt;
       &lt;regex tag="RI-number"&gt;9401xxxxxxx&lt;/regex&gt;
       &lt;regex tag="local-number10"&gt;9xxxxxxxxxx&lt;/regex&gt;
       &lt;regex tag="ddd"&gt;91xxxxxxxxxx&lt;/regex&gt;
       &lt;regex tag="iddd"&gt;011x.&lt;/regex&gt;
     &lt;/pattern&gt;
   &lt;/kpml-request&gt;

                 Figure 17: Dial String KPML Example Code

   Note the use of the "tag" attribute to indicate which regex matched
   the dialed string.  The interesting case here is if the user entered
   "94015551212".  This string matches both the "9401xxxxxxx" and



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   "9xxxxxxxxxx" regular expressions.  Both expressions are the same
   length.  Thus the KPML interpreter will pick the "9401xxxxxxx"
   string, as it occurs first in document order.  Figure 18 shows the
   response.

   &lt;?xml version="1.0"?&gt;
   &lt;kpml-response xmlns="urn:ietf:params:xml:ns:kpml-resposne"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-response kpml-response.xsd"
         version="1.0"
         code="200" text="OK"
         digits="94015551212" tag="RI-number"/&gt;

                   Figure 18: Dial String KPML Response

<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>.  Call Flow Examples</span>

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

   This section gives a non-normative example of an application that
   collects supplemental digits.  Supplemental digit collection is where
   the network requests additional digits after the caller enters the
   destination address.  A typical supplemental dial string is four
   digits in length.


























<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Ingress Gateway      Application Server       Egress Gateway
          |                      |                      |
          |                      |                      |
          |                      |                      |
          |(1) INVITE            |                      |
          |--------------------------------------------&gt;|
          |                      |                      |
          |                      |                      |
          |(2) 200 OK            |                      |
          |&lt;--------------------------------------------|
          |                      |                      |
          |                      |                      |
          |(3) ACK               |                      |
          |--------------------------------------------&gt;|
          |                      |                      |
          |                      |                      |
          |(4) SUBSCRIBE (one-shot)                     |
          |&lt;---------------------|                      |
          |                      |                      |
          |                      |                      |
          |(5) 200 OK            |                      |
          |---------------------&gt;|                      |
          |                      |                      |
          |                      |                      |
          |(6) NOTIFY            |                      |
          |---------------------&gt;|                      |
          |                      |                      |
          |                      |                      |
          |(7) 200 OK            |                      |
          |&lt;---------------------|                      |
          |                      |                      |
          |                      |                      |
          |(8)                   |                      |
          |......................|                      |
          |                      |                      |
          |                      |                      |
          |(9) NOTIFY (digits)   |                      |
          |---------------------&gt;|                      |
          |                      |                      |
          |                      |                      |
          |(10) 200 OK           |                      |
          |&lt;---------------------|                      |
          |                      |                      |
          |                      |                      |
          |                      |                      |
          |                      |                      |

                 Figure 19: Supplemental Digits Call Flow



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   In messages (1-3), the ingress gateway establishes a dialog with an
   egress gateway.  The application learns the dialog ID through out-of-
   band mechanisms, such as the Dialog Package or being co-resident with
   the egress gateway.  Part of the ACK message is below, to illustrate
   the dialog identifiers.

   ACK sip:gw@subA.example.com SIP/2.0
   Via: ...
   Max-Forwards: ...
   Route: ...
   From: &lt;sip:phn@example.com&gt;;tag=jfh21
   To: &lt;sip:gw@subA.example.com&gt;;tag=onjwe2
   Call-ID: 12345592@subA.example.com
   ...

   In message (4), the application the requests that gateway collect a
   string of four key presses.

   SUBSCRIBE sip:gw@subA.example.com SIP/2.0
   Via: SIP/2.0/TCP client.subB.example.com;branch=q4i9ufr4ui3
   From: &lt;sip:ap@subB.example.com&gt;;tag=567890
   To: &lt;sip:gw@subA.example.com&gt;
   Call-ID: 12345601@subA.example.com
   CSeq: 1 SUBSCRIBE
   Contact: &lt;sip:ap@client.subB.example.com&gt;
   Max-Forwards: 70
   Event: kpml ;remote-tag="sip:phn@example.com;tag=jfh21"
               ;local-tag="sip:gw@subA.example.com;tag=onjwe2"
               ;call-id="12345592@subA.example.com"
   Expires: 7200
   Accept: application/kpml-response+xml
   Content-Type: application/kpml-request+xml
   Content-Length: 292

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-request xmlns="urn:ietf:params:xml:ns:kpml-request"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation=
         "urn:ietf:params:xml:ns:kpml-request kpml-request.xsd"
       version="1.0"&gt;
     &lt;pattern persist="one-shot"&gt;
       &lt;regex&gt;xxxx&lt;/regex&gt;
     &lt;/pattern&gt;
   &lt;/kpml-request&gt;







<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Message (5) is the acknowledgement of the subscription request.

   SIP/2.0 200 OK
   Via: SIP/2.0/TCP subB.example.com;branch=q4i9ufr4ui3;
        received=192.168.125.12
   From: &lt;sip:ap@subB.example.com&gt;;tag=567890
   To: &lt;sip:gw@subA.example.com&gt;;tag=1234567
   Call-ID: 12345601@subA.example.com
   CSeq: 1 SUBSCRIBE
   Contact: &lt;sip:gw27@subA.example.com&gt;
   Expires: 3600
   Event: kpml

   Message (6) is the immediate notification of the subscription.

   NOTIFY sip:ap@client.subB.example.com SIP/2.0
   Via: SIP/2.0/UDP subA.example.com;branch=gw27id4993
   To: &lt;sip:ap@subB.example.com&gt;;tag=567890
   From: &lt;sip:gw@subA.example.com&gt;;tag=1234567
   Call-ID: 12345601@subA.example.com
   CSeq: 1000 NOTIFY
   Contact: &lt;sip:gw27@subA.example.com&gt;
   Event: kpml
   Subscription-State: active;expires=3599
   Max-Forwards: 70
   Content-Length: 0

   Message (7) is the acknowledgement of the notification message.

   SIP/2.0 200 OK
   Via: SIP/2.0/TCP subA.example.com;branch=gw27id4993
   To: &lt;sip:ap@subB.example.com&gt;;tag=567890
   From: &lt;sip:gw@subA.example.com&gt;;tag=1234567
   Call-ID: 12345601@subA.example.com
   CSeq: 1000 NOTIFY

   Some time elapses (8).

   The user enters the input.  The device provides the notification of
   the collected digits in message (9).  Since this was a one-shot
   subscription, note the Subscription-State is "terminated".










<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   NOTIFY sip:ap@client.subB.example.com SIP/2.0
   Via: SIP/2.0/UDP subA.example.com;branch=gw27id4993
   To: &lt;sip:ap@subB.example.com&gt;;tag=567890
   From: &lt;sip:gw@subA.example.com&gt;;tag=1234567
   Call-ID: 12345601@subA.example.com
   CSeq: 1001 NOTIFY
   Contact: &lt;sip:gw27@subA.example.com&gt;
   Event: kpml
   Subscription-State: terminated
   Max-Forwards: 70
   Content-Type: application/kpml-response+xml
   Content-Length: 258

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-response xmlns="urn:ietf:params:xml:ns:kpml-response"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-response kpml-response.xsd"
         version="1.0"
         code="200" text="OK"
         digits="4336"/&gt;

   Message (10) is the acknowledgement of the notification.

   SIP/2.0 200 OK
   Via: SIP/2.0/TCP subA.example.com;branch=gw27id4993
   To: &lt;sip:ap@subB.example.com&gt;;tag=567890
   From: &lt;sip:gw@subA.example.com&gt;;tag=1234567
   Call-ID: 12345601@subA.example.com
   CSeq: 1001 NOTIFY





















<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>.  Multiple Applications</span>

   This section gives a non-normative example of multiple applications.
   One application collects a destination number to call.  That
   application then waits for a "long pound."  During the call, the call
   goes to a personal assistant application, which interacts with the
   user.  In addition, the personal assistant application looks for a
   "short pound."

   For clarity, we do not show the INVITE dialogs.

   Gateway           Card Application      Personal Assistant
      |                      |                      |
      |                      |                      |
      |                      |                      |
      |(1) SUBSCRIBE (persistent)                   |
      |&lt;---------------------|                      |
      |                      |                      |
      |                      |                      |
      |(2) 200 OK            |                      |
      |---------------------&gt;|                      |
      |                      |                      |
      |                      |                      |
      |(3) NOTIFY            |                      |
      |---------------------&gt;|                      |
      |                      |                      |
      |                      |                      |
      |(4) 200 OK            |                      |
      |&lt;---------------------|                      |
      |                      |                      |
      |                      |                      |
      |(5)                   |                      |
      |......................|                      |
      |                      |                      |
      |                      |                      |
      |(6) NOTIFY (tag=card) |                      |
      |---------------------&gt;|                      |
      |                      |                      |
      |                      |                      |
      |(7) 200 OK            |                      |
      |&lt;---------------------|                      |
      |                      |                      |
      |                      |                      |
      |(8)                   |                      |
      |......................|                      |
      |                      |                      |
      |                      |                      |
      |(9) NOTIFY (tag=number)                      |



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


      |---------------------&gt;|                      |
      |                      |                      |
      |                      |                      |
      |(10) 200 OK           |                      |
      |&lt;---------------------|                      |
      |                      |                      |
      |                      |                      |
      |(11) SUBSCRIBE        |                      |
      |&lt;--------------------------------------------|
      |                      |                      |
      |                      |                      |
      |(12) 200 OK           |                      |
      |--------------------------------------------&gt;|
      |                      |                      |
      |                      |                      |
      |(13) NOTIFY           |                      |
      |--------------------------------------------&gt;|
      |                      |                      |
      |                      |                      |
      |(14) 200 OK           |                      |
      |&lt;--------------------------------------------|
      |                      |                      |
      |                      |                      |
      |(15)                  |                      |
      |.............................................|
      |                      |                      |
      |                      |                      |
      |(16) NOTIFY (tag=number)                     |
      |--------------------------------------------&gt;|
      |                      |                      |
      |                      |                      |
      |(17) 200 OK           |                      |
      |&lt;--------------------------------------------|
      |                      |                      |
      |                      |                      |
      |(18)                  |                      |
      |.............................................|
      |                      |                      |
      |                      |                      |
      |(19) NOTIFY (tag=#)   |                      |
      |--------------------------------------------&gt;|
      |                      |                      |
      |                      |                      |
      |(20) 200 OK           |                      |
      |&lt;--------------------------------------------|
      |                      |                      |
      |                      |                      |
      |(21)                  |                      |



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


      |.............................................|
      |                      |                      |
      |                      |                      |
      |(22) NOTIFY (tag=number)                     |
      |--------------------------------------------&gt;|
      |                      |                      |
      |                      |                      |
      |(23) 200 OK           |                      |
      |&lt;--------------------------------------------|
      |                      |                      |
      |                      |                      |
      |(24)                  |                      |
      |.............................................|
      |                      |                      |
      |                      |                      |
      |(25) NOTIFY (L#)      |                      |
      |---------------------&gt;|                      |
      |                      |                      |
      |                      |                      |
      |(26) 200 OK           |                      |
      |&lt;---------------------|                      |
      |                      |                      |
      |                      |                      |
      |                      |                      |
      |                      |                      |

                 Figure 27: Multiple Application Call Flow

   Message (1) is the subscription request for the card number.

   SUBSCRIBE sip:gw@subA.example.com SIP/2.0
   Via: SIP/2.0/TCP client.subB.example.com;branch=3qo3j0ouq
   From: &lt;sip:ap@subB.example.com&gt;;tag=978675
   To: &lt;sip:gw@subA.example.com&gt;
   Call-ID: 12345601@subA.example.com
   CSeq: 20 SUBSCRIBE
   Contact: &lt;sip:ap@client.subB.example.com&gt;
   Max-Forwards: 70
   Event: kpml ;remote-tag="&lt;sip:phn@example.com;tag=jfi23&gt;"
               ;local-tag="sip:gw@subA.example.com;tag=oi43jfq"
               ;call-id="12345598@subA.example.com"
   Expires: 7200
   Accept: application/kpml-response+xml
   Content-Type: application/kpml-request+xml
   Content-Length: 339






<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-request xmlns="urn:ietf:params:xml:ns:kpml-request"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-request kpml-request.xsd"
         version="1.0"&gt;
     &lt;pattern persist="persist"&gt;
       &lt;regex tag="card"&gt;x{16}&lt;/regex&gt;
       &lt;regex tag="number"&gt;x{10}&lt;/regex&gt;
     &lt;/pattern&gt;
   &lt;/kpml-request&gt;

   Messages (2-4) are not shown, for brevity.  Message (6) is the
   notification of the card number.

   NOTIFY sip:ap@client.subB.example.com SIP/2.0
   Via: SIP/2.0/UDP subA.example.com;branch=3qo3j0ouq
   To: &lt;sip:ap@subB.example.com&gt;;tag=978675
   From: &lt;sip:gw@subA.example.com&gt;;tag=9783453
   Call-ID: 12345601@subA.example.com
   CSeq: 3001 NOTIFY
   Contact: &lt;sip:gw27@subA.example.com&gt;
   Event: kpml
   Subscription-State: active;expires=3442
   Max-Forwards: 70
   Content-Type: application/kpml-response+xml
   Content-Length: 271

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-response xmlns="urn:ietf:params:xml:ns:kpml-response"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-response kpml-response.xsd"
         version="1.0"
         code="200" text="OK"
         digits="9999888877776666"/&gt;















<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Message (7) is the acknowledgement of the notification.  Time goes by
   in (8).  Message (9) is the notification of the dialed number.

   NOTIFY sip:ap@client.subB.example.com SIP/2.0
   Via: SIP/2.0/UDP subA.example.com;branch=3qo3j0ouq
   To: &lt;sip:ap@subB.example.com&gt;;tag=978675
   From: &lt;sip:gw@subA.example.com&gt;;tag=9783453
   Call-ID: 12345601@subA.example.com
   CSeq: 3001 NOTIFY
   Contact: &lt;sip:gw27@subA.example.com&gt;
   Event: kpml
   Subscription-State: active;expires=3542
   Max-Forwards: 70
   Content-Type: application/kpml-response+xml
   Content-Length: 278

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-response xmlns="urn:ietf:params:xml:ns:kpml-response"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-response kpml-response.xsd"
         version="1.0"
         code="200" text="OK"
         digits="2225551212" tag="number"/&gt;

   Message (11) is the request for long-pound monitoring.

   SUBSCRIBE sip:gw@subA.example.com SIP/2.0
   Via: SIP/2.0/TCP client.subB.example.com;branch=3qo3j0ouq
   From: &lt;sip:ap@subB.example.com&gt;;tag=978675
   To: &lt;sip:gw@subA.example.com&gt;
   Call-ID: 12345601@subA.example.com
   CSeq: 21 SUBSCRIBE
   Contact: &lt;sip:ap@client.subB.example.com&gt;
   Max-Forwards: 70
   Event: kpml ;remote-tag="&lt;sip:phn@example.com;tag=jfi23&gt;"
               ;local-tag="sip:gw@subA.example.com;tag=oi43jfq"
               ;call-id="12345598@subA.example.com"
   Expires: 7200
   Accept: application/kpml-response+xml
   Content-Type: application/kpml-request+xml
   Content-Length: 295









<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-request xmlns="urn:ietf:params:xml:ns:kpml-request"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-request kpml-request.xsd"
         version="1.0"&gt;
     &lt;pattern persist="single-notify"&gt;
       &lt;regex&gt;L#&lt;/regex&gt;
     &lt;/pattern&gt;
   &lt;/kpml-request&gt;

   Message (13) is the request from the personal assistant application
   for number and pound sign monitoring.

   SUBSCRIBE sip:gw@subA.example.com SIP/2.0
   Via: SIP/2.0/TCP pahost.example.com;branch=xzvsadf
   From: &lt;sip:pa@example.com&gt;;tag=4rgj0f
   To: &lt;sip:gw@subA.example.com&gt;
   Call-ID: 93845@pahost.example.com
   CSeq: 21 SUBSCRIBE
   Contact: &lt;sip:pa12@pahost.example.com&gt;
   Max-Forwards: 70
   Event: kpml ;remote-tag="&lt;sip:phn@example.com;tag=jfi23&gt;"
               ;local-tag="sip:gw@subA.example.com;tag=oi43jfq"
               ;call-id="12345598@subA.example.com"
   Expires: 7200
   Accept: application/kpml-response+xml
   Content-Type: application/kpml-request+xml
   Content-Length: 332

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-request xmlns="urn:ietf:params:xml:ns:kpml-request"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-request kpml-request.xsd"
         version="1.0"&gt;
     &lt;pattern persist="persist"&gt;
       &lt;regex tag="number"&gt;x{10}&lt;/regex&gt;
       &lt;regex tag="#"&gt;#&lt;/regex&gt;
     &lt;/pattern&gt;
   &lt;/kpml-request&gt;










<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Message (18) is the notification of the number collected.

   NOTIFY sip:pa@example.com SIP/2.0
   Via: SIP/2.0/UDP subA.example.com;branch=xzvsadf
   To: &lt;sip:pa@example.com&gt;;tag=4rgj0f
   From: &lt;sip:gw@subA.example.com&gt;;tag=9788823
   Call-ID: 93845@pahost.example.com
   CSeq: 3021 NOTIFY
   Contact: &lt;sip:gw27@subA.example.com&gt;
   Event: kpml
   Subscription-State: active;expires=3540
   Max-Forwards: 70
   Content-Type: application/kpml-response+xml
   Content-Length: 278

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-response xmlns="urn:ietf:params:xml:ns:kpml-response"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-response kpml-response.xsd"
         version="1.0"
         code="200" text="OK" digits="3335551212" tag="number"/&gt;

   Message (21) is the notification of pound sign detected.

   NOTIFY sip:pa@example.com SIP/2.0
   Via: SIP/2.0/UDP subA.example.com;branch=xzvsadf
   To: &lt;sip:pa@example.com&gt;;tag=4rgj0f
   From: &lt;sip:gw@subA.example.com&gt;;tag=9788823
   Call-ID: 93845@pahost.example.com
   CSeq: 3022 NOTIFY
   Contact: &lt;sip:gw27@subA.example.com&gt;
   Event: kpml
   Subscription-State: active;expires=3540
   Max-Forwards: 70
   Content-Type: application/kpml-response+xml
   Content-Length: 264

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-response xmlns="urn:ietf:params:xml:ns:kpml-response"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-response kpml-response.xsd"
         version="1.0"
         code="200" text="OK"
         digits="#" tag="#"/&gt;





<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   Message (27) is the notification of long pound to the card
   application.

   NOTIFY sip:ap@client.subB.example.com SIP/2.0
   Via: SIP/2.0/UDP subA.example.com;branch=3qo3j0ouq
   To: &lt;sip:ap@subB.example.com&gt;;tag=978675
   From: &lt;sip:gw@subA.example.com&gt;;tag=9783453
   Call-ID: 12345601@subA.example.com
   CSeq: 3037 NOTIFY
   Contact: &lt;sip:gw27@subA.example.com&gt;
   Event: kpml
   Subscription-State: active;expires=3216
   Max-Forwards: 70
   Content-Type: application/kpml-response+xml
   Content-Length: 256

   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
   &lt;kpml-response xmlns="urn:ietf:params:xml:ns:kpml-response"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation=
           "urn:ietf:params:xml:ns:kpml-response kpml-response.xsd"
         version="1.0"
         code="200" text="OK"
         digits="#"/&gt;

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

<span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.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>]  Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
        Specifications: ABNF", <a href="./rfc4234">RFC 4234</a>, October 2005.

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

   [<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>]  Roach, A., "Session Initiation Protocol (SIP)-Specific Event
        Notification", <a href="./rfc3265">RFC 3265</a>, June 2002.

   [<a id="ref-6">6</a>]  Daigle, L., van Gulik, D., Iannella, R., and P. Faltstrom,
        "Uniform Resource Names (URN) Namespace Definition Mechanisms",
        <a href="https://www.rfc-editor.org/bcp/bcp66">BCP 66</a>, <a href="./rfc3406">RFC 3406</a>, October 2002.



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 52]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


   [<a id="ref-7">7</a>]  Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
        January 2004.

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

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

   [<a id="ref-9">9</a>]   Rosenberg, J., "Obtaining and Using Globally Routable User
         Agent (UA) URIs (GRUU) in the  Session Initiation Protocol
         (SIP)", Work in Progress, June 2006.

   [<a id="ref-10">10</a>]  Schulzrinne, H. and S. Petrack, "RTP Payload for DTMF Digits,
         Telephony Tones and Telephony Signals", <a href="./rfc2833">RFC 2833</a>, May 2000.

   [<a id="ref-11">11</a>]  Andreasen, F. and B. Foster, "Media Gateway Control Protocol
         (MGCP) Version 1.0", <a href="./rfc3435">RFC 3435</a>, January 2003.

   [<a id="ref-12">12</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-13">13</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-14">14</a>]  Bray, T., Paoli, J., Sperberg-McQueen, C., and E. Maler,
         "Extensible Markup Language (XML) 1.0 (Second Edition)", W3C
         REC REC-xml-20001006, October 2000.

   [<a id="ref-15">15</a>]  Rosenberg, J., "A Framework for Application Interaction in the
         Session Initiation Protocol  (SIP)", Work in Progress,
         July 2005.

   [<a id="ref-16">16</a>]  Burger, E., Van Dyke, J., and A. Spitzer, "Media Server Control
         Markup Language (MSCML) and Protocol", <a href="./rfc4722">RFC 4722</a>, November 2006.

   [<a id="ref-17">17</a>]  Rosenberg, J., Schulzrinne, H., and R. Mahy, "An INVITE-
         Initiated Dialog Event Package for the Session Initiation
         Protocol (SIP)", <a href="./rfc4235">RFC 4235</a>, November 2005.

   [<a id="ref-18">18</a>]  Roach, A., Campbell, B., and J. Rosenberg, "A Session
         Initiation Protocol (SIP) Event Notification Extension for
         Resource Lists", <a href="./rfc4662">RFC 4662</a>, August 2006.






<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 53]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


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

   Ophir Frieder of the Illinois Institute of Technology collaborated on
   the development of the buffer algorithm.

   Jeff Van Dyke worked enough hours and wrote enough text to be
   considered an author under the old rules.

   Robert Fairlie-Cuninghame, Cullen Jennings, Jonathan Rosenberg, and
   we were the members of the Application Stimulus Signaling Design
   Team.  All members of the team contributed to this work.  In
   addition, Jonathan Rosenberg postulated DML in his "A Framework for
   Stimulus Signaling in SIP Using Markup" draft.

   This version of KPML has significant influence from MSCML [<a href="#ref-16" title="&quot;Media Server Control Markup Language (MSCML) and Protocol&quot;">16</a>], the
   SnowShore Media Server Control Markup Language.  Jeff Van Dyke and
   Andy Spitzer were the primary contributors to that effort.

   Rohan Mahy did a significant reorganization of the content, as well
   as providing considerable moral support in the production of this
   document.

   That said, any errors, misinterpretation, or fouls in this document
   are our own.

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

   Hal Purdy and Eric Cheung of AT&amp;T Laboratories helped immensely
   through many conversations and challenges.

   Steve Fisher of AT&amp;T Laboratories suggested the digit suppression
   syntax and provided excellent review of the document.

   Terence Lobo of SnowShore Networks made it all work.

   Jerry Kamitses, Swati Dhuleshia, Shaun Bharrat, Sunil Menon, and
   Bryan Hill helped with clarifying the buffer behavior and DRegex
   syntax.

   Silvano Brewster and Bill Fenner of AT&amp;T Laboratories and Joe Zebarth
   of Nortel helped considerably with making the text clear and DRegex
   tight.

   Bert Culpepper and Allison Mankin gave an early version of this
   document a good scouring.

   Scott Hollenbeck provided XML and MIME review.  Tim Bray pointed out
   the general issue of UTF-8 versus UTF-16 with XML.



<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 54]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


Authors' Addresses

   Eric Burger
   Cantata Technology, Inc.
   18 Keewaydin Dr.
   Salem, NH  03079
   USA

   EMail: eburger@cantata.com


   Martin Dolly
   AT&amp;T Labs

   EMail: mdolly@att.com




































<span class="grey">Burger &amp; Dolly              Standards Track                    [Page 55]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
<span class="grey"><a href="./rfc4730">RFC 4730</a>                          KPML                     November 2006</span>


Full Copyright Statement

   Copyright (C) The IETF Trust (2006).

   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 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.

Acknowledgement

   Funding for the RFC Editor function is currently provided by the
   Internet Society.






Burger &amp; Dolly              Standards Track                    [Page 56]
</pre>