xeps/xep-0181.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>Jingle DTMF</title>
  <abstract>This document specifies an XML format for encapsulating DTMF data in informational messages sent within the context of Jingle audio interactions.</abstract>
  &LEGALNOTICE;
  <number>0181</number>
  <status>Proposed</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0166</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>TO BE ASSIGNED</shortname>
  &stpeter;
  &seanegan;
  <revision>
    <version>0.7</version>
    <date>2007-11-27</date>
    <initials>psa</initials>
    <remark><p>Editorial review and consistency check; corrected the schema.</p></remark>
  </revision>
  <revision>
    <version>0.6</version>
    <date>2007-06-20</date>
    <initials>psa</initials>
    <remark><p>Corrected several errors and updated to reflect changes to core Jingle spec.</p></remark>
  </revision>
  <revision>
    <version>0.5</version>
    <date>2006-12-21</date>
    <initials>psa</initials>
    <remark><p>Defined schema for error namespace; modified spec to use provisional namespace before advancement to Draft (per XEP-0053).</p></remark>
  </revision>
  <revision>
    <version>0.4</version>
    <date>2006-10-31</date>
    <initials>se/psa</initials>
    <remark><p>Specified error handling and service discovery.</p></remark>
  </revision>
  <revision>
    <version>0.3</version>
    <date>2006-07-12</date>
    <initials>se/psa</initials>
    <remark><p>Updated syntax to use action and code attributes rather than tone element in order to provide real-time interaction; specified how to negotiate use of the RFC 4733 format via content-info messages.</p></remark>
  </revision>
  <revision>
    <version>0.2</version>
    <date>2006-06-29</date>
    <initials>psa</initials>
    <remark><p>Allowed characters A, B, C, and D; updated schema.</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2006-03-23</date>
    <initials>psa</initials>
    <remark><p>Initial version.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2006-03-21</date>
    <initials>psa</initials>
    <remark>First draft.</remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>Traditional telephony systems use Dual Tone Multi-Frequency (DTMF) 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>XMPP clients that use &xep0166; for voice chat (see &xep0167;) MUST support the protocol described in this document to exchange DTMF information, although they MAY also support other methods of communicating DTMF information.</p>
</section1>
<section1 topic='Tone Format' anchor='format'>
  <p>The format for the XML DTMF representation is as follows &NSNOTE;:</p>
  <example caption="Basic DTMF Format"><![CDATA[
<dtmf xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns'
      action='[button-down|button-up]'
      code='integer'/>
  ]]></example>
  <p>The &lt;dtmf/&gt; element SHOULD possess an 'action' attribute, the value of which MUST be either "button-up" or "button-down" (specifying whether the button is being depressed or released). This enables DTMF tones to be reconstructed in real time. If the 'action' attribute is not included, the recipient MUST assume that the action is a "button-down" event and act as if a "button-up" event occurs after a reasonable timeout (100 milliseconds is RECOMMENDED) or when another DMTF event is received.</p>
  <p>Unless the 'action' attribute has a value of "button-up", the &lt;dmtf/&gt; element MUST possess a 'code' attribute that specifies 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></p>
  <p>The &lt;dtmf&gt; element SHOULD be sent as the payload of a Jingle session-info message as illustrated in the following example &NSNOTE;.</p>
  <example caption="Entity Sends DTMF Message"><![CDATA[
<iq from='juliet@capulet.com/balcony'
    id='dtmf1'
    to='ivr.shakespeare.lit'
    type='set'>
  <jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
          action='session-info'
          initiator='juliet@capulet.com/balcony'
          sid='a73sjjvkla37jfea'>
    <dtmf xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns'
          action='button-down'
          code='7'/>
  </jingle>
</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[
<iq from='ivr.shakespeare.lit'
    id='dtmf1'
    to='juliet@capulet.com/balcony'
    type='result'/>
  ]]></example>
  <p>If the receiving entity does not understand or cannot process the payload, it MUST return a &feature; stanza error, which SHOULD include a Jingle-specific error condition of &lt;unsupported-info/&gt;.</p>
  <example caption="Receiving Does Not Understand DTMF Info Message"><![CDATA[
<iq from='ivr.shakespeare.lit'
    id='dtmf1'
    to='juliet@capulet.com/balcony'
    type='error'>
  <error type='cancel'>
    <feature-not-implemented xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
    <unsupported-info xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns-errors'/>
  </error>
</iq>
  ]]></example>
</section1>
<section1 topic='Negotiating Use of the RFC 4733 Format' anchor='rfc4733'>
 <p>Some applications may want to stream Jingle voice RTP directly to a non-XMPP entity, such as a SIP phone (see &rfc3261;). In this scenario, DTMF needs to be sent in the content channel. Jingle DTMF enables Jingle entities to negotiate whether to send RTP over the XMPP signalling channel as described above, or over the content channel using &rfc4733;.</p>
 <p>To request that the voice session will switch to use of the RFC 4733 format for communicating DTMF, a client sends a &lt;dtmf-method/&gt; element, qualified by the 'http://www.xmpp.org/extensions/xep-0181.html#ns' namespace as the payload of a Jingle session-info message:</p>
 <example caption="Client Requests Use of RFC 4733"><![CDATA[
<iq from='juliet@capulet.com/balcony'
    id='dtmf2'
    to='ivr.shakespeare.lit'
    type='set'>
  <jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
          action='session-info'
          initiator='juliet@capulet.com/balcony'
          sid='a73sjjvkla37jfea'>
    <dtmf-method xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns' method='rtp'>
  </jingle>
</iq>
 ]]></example>
<p>The dtmf-method element MUST contain one 'method' attribute, the value of which SHOULD be either 'rtp' or 'xmpp'.</p>
<p>If the recipient supports the requested DTMF method and wishes to use that method, it MUST send an empty IQ result:</p>
 <example caption="Recipient Acknowledges Request"><![CDATA[
<iq from='ivr.shakespeare.lit'
    to='juliet@capulet.com/balcony'
    id='dtmf2'
    type='result'/>
 ]]></example>
<p>If the recipient does not support the requested DTMF method, it MUST return a &lt;feature-not-implemented/&gt; stanza error, which SHOULD include a DTMF-specific error condition of &lt;unsupported-dtmf-method/&gt;:</p>
<example caption="Recipient Refuses Request"><![CDATA[
<iq from='ivr.shakespeare.lit'
    to='juliet@capulet.com/balcony'
    id='dtmf2'
    type='error'>
  <error type='cancel'>
    <feature-not-implemented xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
    <unsupported-dtmf-method xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns-errors'/>
  </error>
</iq>
 ]]></example>
</section1>

<section1 topic='Determining Support' anchor='disco'>
  <p>If an entity supports Jingle DTMF (which natively includes sending of DTMF in the XMPP signalling channel), it MUST return a &xep0030; feature of "http://www.xmpp.org/extensions/xep-0181.html#ns" in response to service discovery information requests.</p>
  <p>If an entity also supports sending of DTMF in the content channel, it MUST also return a service discovery feature of "http://www.xmpp.org/extensions/xep-0181.html#ns-rtp" in response to service discovery information requests.</p>
  <p>Naturally, support MAY also be determined via the dynamic, presence-based profile of Service Discovery defined in &xep0115;.</p>
</section1>

<section1 topic='Security Considerations' anchor='security'>
  <p>This document introduces no known security vulnerabilities.</p>
</section1>

<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>

<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <section2 topic='Protocol Namespaces' anchor='ns'>
    <p>Until this specification advances to a status of Draft, its associated namespaces shall be "http://www.xmpp.org/extensions/xep-0181.html#ns" and "http://www.xmpp.org/extensions/xep-0181.html#ns-errors"; upon advancement of this specification, the &REGISTRAR; shall issue permanent namespaces in accordance with the process defined in Section 4 of &xep0053;.</p>
  </section2>
  <section2 topic='Service Discovery Features' anchor='registrar-disco'>
    <p>The XMPP Registrar shall include 'http://www.xmpp.org/extensions/xep-0181.html#ns-rtp' in its registry of service discovery features.</p>
  </section2>
</section1>

<section1 topic='XML Schema' anchor='schema'>
  <section2 topic='DTMF' anchor='schema-dtmf'>
    <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://www.xmpp.org/extensions/xep-0181.html#ns'
    xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns'
    elementFormDefault='qualified'>

  <xs:element name='dtmf'>
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base='empty'>
          <xs:attribute name='action' use='optional' default='button-down'>
            <xs:simpleType>
              <xs:restriction base='xs:NCName'>
                <xs:enumeration value='button-down'/>
                <xs:enumeration value='button-up'/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name='code' type='DTMFString' use='required'/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>

  <xs:element name='dtmf-method'>
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base='empty'>
          <xs:attribute name='role' use='optional' default='xmpp'>
            <xs:simpleType>
              <xs:restriction base='xs:NCName'>
                <xs:enumeration value='rtp'/>
                <xs:enumeration value='xmpp'/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name="DTMFString">
    <xs:restriction base="xs:string">
      <xs:pattern value="(#|\*|0|1|2|3|4|5|6|7|8|9|A|B|C|D)*" />
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>

</xs:schema>
    ]]></code>
  </section2>
  <section2 topic='DTMF Errors' anchor='schema-dtmferrors'>
    <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://www.xmpp.org/extensions/xep-0181.html#ns-errors'
    xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns-errors'
    elementFormDefault='qualified'>

  <xs:element name='unsupported-dtmf-method' type='empty'/>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>

</xs:schema>
    ]]></code>
  </section2>
</section1>
</xep>