0.11

git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@2257 4b5297f7-1745-476d-ba37-a9c6900126ab

xep-0181.xml

@@ -7,7 +7,7 @@
 <xep>
 <header>
   <title>Jingle DTMF</title>
-  <abstract>This specification defines an XML format for encapsulating Dual Tone Multi-Frequency (DTMF) events in informational messages sent within the context of Jingle audio sessions, e.g. to be used in the context of Interactive Voice Response (IVR) systems.</abstract>
+  <abstract>This specification defines an XML format for encapsulating Dual Tone Multi-Frequency (DTMF) events in informational messages sent within the context of Jingle audio sessions, e.g. to be used in the context of Interactive Voice Response (IVR) systems. Note well that this format is not to be used in the context of RTP sessions, where native RTP methods are to be used instead.</abstract>
   &LEGALNOTICE;
   <number>0181</number>
   <status>Experimental</status>
@@ -23,6 +23,12 @@
   <shortname>NOT_YET_ASSIGNED</shortname>
   &stpeter;
   &seanegan;
+  <revision>
+    <version>0.11</version>
+    <date>2008-09-23</date>
+    <initials>psa</initials>
+    <remark><p>Clarified that use of this protocol is discouraged for RTP-aware applications and is designed only for communication with endpoints that do not support RTP.</p></remark>
+  </revision>
   <revision>
     <version>0.10</version>
     <date>2008-05-30</date>
@@ -91,17 +97,18 @@
   </revision>
 </header>
 <section1 topic='Introduction' anchor='intro'>
-  <p>Traditional telephony systems use Dual Tone Multi-Frequency (DTMF) events for dialing and to issue commands such as those used in Interactive Voice Response (IVR) applications. Internet telephony systems also use DTMF tones for interoperability with the public switched telephone network (PSTN).</p>
+  <p>Traditional telephony systems such as the public switched telephone network (PSTN) use Dual Tone Multi-Frequency (DTMF) events for dialing and to issue commands such as those used in interactive voice response (IVR) applications. Internet telephony systems also use DTMF tones, usually for interoperability with the PSTN but sometimes also in native Internet services.</p>
-  <p>If XMPP application use &xep0166; for voice chat (see &xep0167;) and wish to exchange DTMF events, they MUST support the protocol described in this document. However, they MAY also support non-XMPP methods of communicating DTMF information, such as the "audio/telephone-event" and "audio/tone" media types as sent over the Real-time Transport Protocol (&rfc3550;).</p>
+  <p>XMPP applications that use &xep0166; and the Real-time Transport Protocol (&rfc3550;) for voice chat as described in &xep0167; MUST support and prefer native RTP methods of communicating DTMF information, in particular the "audio/telephone-event" and "audio/tone" media types. Such applications SHOULD NOT use the protocol described herein for communicating DTMF information with RTP-aware endpoints.</p>
+  <p>However, XMPP applications MAY support and use the protocol described herein for communicating DTMF information with endpoints that are not RTP-aware, such as gateways to the PSTN.</p>
 </section1>
 <section1 topic='Format' anchor='format'>
-  <p>The format for the representation of DTMF events in XMPP is as follows &NSNOTE;:</p>
+  <p>The format for the representation of DTMF events over XMPP is as follows &VNOTE;:</p>
-  <example caption="Basic DTMF Format"><![CDATA[
+  <code><![CDATA[
-<dtmf xmlns='urn:xmpp:tmp:jingle:dtmf'
+<dtmf xmlns='urn:xmpp:jingle:dtmf:0'
       code='0-9,#,*,A-D'
       duration='milliseconds'
       volume='0-63'/>
-  ]]></example>
+  ]]></code>
   <p>The &lt;dmtf/&gt; element MUST be empty.</p>
   <p>The attributes of the &lt;dmtf/&gt; element are as follows.</p>
   <table caption='Defined Attributes'>
@@ -114,7 +121,7 @@
     <tr>
       <td>code</td>
       <td>The tone to be generated. The value of the 'code' attribute SHOULD be one the following characters: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, #, and * (however, the characters A, B, C, and D MAY be sent as well <note>Although A, B, C, and D were originally defined as part of DTMF, they were never deployed to telephony consumers and were used only for control purposes at private branch exchanges (PBXs) and central office operator stations; however, they are used in certain non-telephony applications of DTMF, such as ham radio.</note>).</td>
-      <td>6</td>
+      <td>#</td>
       <td>REQUIRED</td>
     </tr>
     <tr>
@@ -131,16 +138,16 @@
     </tr>
   </table>
   <p>The &lt;dtmf&gt; element SHOULD be sent as the payload of a Jingle session-info message as illustrated in the following example.</p>
-  <example caption="Entity Sends DTMF Message"><![CDATA[
+  <example caption="Entity sends DTMF message"><![CDATA[
 <iq from='juliet@capulet.com/balcony'
     id='dtmf1'
     to='ivr.shakespeare.lit'
     type='set'>
-  <jingle xmlns='urn:xmpp:tmp:jingle'
+  <jingle xmlns='urn:xmpp:jingle:0'
           action='session-info'
           initiator='juliet@capulet.com/balcony'
           sid='a73sjjvkla37jfea'>
-    <dtmf xmlns='urn:xmpp:tmp:jingle:dtmf'
+    <dtmf xmlns='urn:xmpp:jingle:dtmf:0'
           code='7'
           duration='400'
           volume='42'/>
@@ -148,14 +155,14 @@
 </iq>
   ]]></example>
   <p>The receiving entity MUST send an IQ result if it can process the DTMF:</p>
-  <example caption="Receiving Entity Acknowledges DTMF Message"><![CDATA[
+  <example caption="Receiving entity acknowledges DTMF message"><![CDATA[
 <iq from='ivr.shakespeare.lit'
     id='dtmf1'
     to='juliet@capulet.com/balcony'
     type='result'/>
   ]]></example>
   <p>If the receiving entity does not support this protocol, it MUST return a &unavailable; stanza error.</p>
-  <example caption="Receiving Does Not Support DTMF Protocol"><![CDATA[
+  <example caption="Receiving entity does not support DTMF protocol"><![CDATA[
 <iq from='ivr.shakespeare.lit'
     id='dtmf1'
     to='juliet@capulet.com/balcony'
@@ -166,7 +173,7 @@
 </iq>
   ]]></example>
   <p>If the receiving entity does not understand the specified code, it MUST return a &feature; stanza error.</p>
-  <example caption="Receiving Does Not Understand Code"><![CDATA[
+  <example caption="Receiving does not understand code"><![CDATA[
 <iq from='ivr.shakespeare.lit'
     id='dtmf1'
     to='juliet@capulet.com/balcony'
@@ -177,7 +184,7 @@
 </iq>
   ]]></example>
   <p>If the receiving entity is using or wishes to use a different method for exchanging DTMF events (e.g., the methods specified in &rfc2833; or its successor &rfc4733;), it MUST return a &notacceptable; stanza error.</p>
-  <example caption="Receiving Prefers Non-XMPP DTMF Method"><![CDATA[
+  <example caption="Receiving prefers non-XMPP DTMF method"><![CDATA[
 <iq from='ivr.shakespeare.lit'
     id='dtmf1'
     to='juliet@capulet.com/balcony'
@@ -190,7 +197,8 @@
 </section1>
 
 <section1 topic='Determining Support' anchor='disco'>
-  <p>If an entity supports Jingle DTMF (i.e., sending of DTMF in the XMPP signalling channel as specified herein), it MUST return a &xep0030; feature of "urn:xmpp:tmp:jingle:dtmf" in response to service discovery information requests. Naturally, support MAY also be determined via the dynamic, presence-based profile of Service Discovery defined in &xep0115;.</p>
+  <p>If an entity supports Jingle DTMF (i.e., sending of DTMF in the XMPP signalling channel as specified herein), it MUST return a &xep0030; feature of "urn:xmpp:jingle:dtmf:0" in response to service discovery information requests.</p>
+  <p>In order for an application to determine whether an entity supports this protocol, where possible it SHOULD use the dynamic, presence-based profile of service discovery defined in &xep0115;. However, if an application has not received entity capabilities information from an entity, it SHOULD use explicit service discovery instead.</p>
 </section1>
 
 <section1 topic='Security Considerations' anchor='security'>
@@ -202,8 +210,15 @@
 </section1>
 
 <section1 topic='XMPP Registrar Considerations' anchor='registrar'>
-  <section2 topic='Protocol Namespaces' anchor='ns'>
+  <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
-    <p>Until this specification advances to a status of Draft, its associated namespace shall be "urn:xmpp:tmp:jingle:dtmf". Upon advancement of this specification, the &REGISTRAR; shall issue a permanent namespace in accordance with the process defined in Section 4 of &xep0053;. The following namespace is requested, and is thought to be unique per the XMPP Registrar's requirements: "urn:xmpp:jingle:dtmf".</p>
+    <p>This specification defines the following XML namespace:</p>
+    <ul>
+      <li>urn:xmpp:jingle:dtmf:0</li>
+    </ul>
+    <p>Upon advancement of this specification from a status of Experimental to a status of Draft, the &REGISTRAR; shall add the foregoing namespaces to the registry located at &NAMESPACES;, as described in Section 4 of &xep0053;.</p>
+  </section2>
+  <section2 topic='Protocol Versioning' anchor='registrar-versioning'>
+    <p>If the protocol defined in this specification undergoes a major revision that is not fully backward-compatible with an older version, or that contains significant new features, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of <cite>XEP-0053</cite>.</p>
   </section2>
 </section1>
 
@@ -213,17 +228,24 @@
 
 <xs:schema
     xmlns:xs='http://www.w3.org/2001/XMLSchema'
-    targetNamespace='urn:xmpp:tmp:jingle:dtmf'
+    targetNamespace='urn:xmpp:jingle:dtmf:0'
-    xmlns='urn:xmpp:tmp:jingle:dtmf'
+    xmlns='urn:xmpp:jingle:dtmf:0'
     elementFormDefault='qualified'>
 
   <xs:element name='dtmf'>
     <xs:complexType>
       <xs:simpleContent>
         <xs:extension base='empty'>
-          <xs:attribute name='code' type='DTMFString' use='required'/>
+          <xs:attribute name='code'
-          <xs:attribute name='duration' type='xs:nonNegativeInteger' use='optional' default='100'/>
+                        type='DTMFString'
-          <xs:attribute name='volume' type='VolumeDigit' use='optional'/>
+                        use='required'/>
+          <xs:attribute name='duration'
+                        type='xs:nonNegativeInteger'
+                        use='optional'
+                        default='100'/>
+          <xs:attribute name='volume'
+                        type='VolumeDigit'
+                        use='optional'/>
         </xs:extension>
       </xs:simpleContent>
     </xs:complexType>
@@ -252,6 +274,6 @@
   ]]></code>
 </section1>
 <section1 topic='Acknowledgements' anchor='ack'>
-  <p>Thanks to Olivier Cr&#234;te and Paul Witty for their feedback. Several sentences were borrowed from <cite>RFC 4733</cite>.</p>
+  <p>Thanks to Diana Cionoiu, Olivier Cr&#234;te, Robert McQueen, and Paul Witty for their feedback. Several sentences were borrowed from <cite>RFC 4733</cite>.</p>
 </section1>
 </xep>