moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-24 10:12:19 -05:00
Code Issues Releases Wiki Activity

0.6

Browse Source 
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@984 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2007-06-20 17:59:14 +00:00
parent ab8529095a
commit 80404104ee
1 changed files with 32 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
xep-0181.xml
View File

@ -23,6 +23,12 @@
<shortname>TO BE ASSIGNED</shortname>
&stpeter;
&seanegan;
<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>
@ -64,22 +70,22 @@
<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). XMPP clients that use &xep0166; for voice chat (see &xep0167;) MUST use the protocol described in this document if they wish to support DTMF.</p>
</section1>
<section1 topic='Tone Format' anchor='format'>
<p>The format for the XML DTMF format is as follows:</p>
<p>The format for the XML DTMF representation is as follows &NSNOTE;:</p>
<example caption="Basic DTMF Format"><![CDATA[
<dtmf xmlns='http://jabber.org/protocol/info/dtmf'
<dtmf xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns'
action='button-down'
code='integer'/>
]]></example>
<p>The &lt;dtmf/&gt; element SHOULD possess one 'action' attribute, which MUST be either "button-up" or "button-down", specifying whether the button is being depressed or released. This allows DTMF tones to be reconstructed in real-time. If the 'action' attribute is not included, the recipient MUST assume this to be a "button-down" event, and imply a "button-up" event after a reasonable timeout (100 milliseconds is RECOMMENDED) or when another DMTF event is received.</p>
<p>Unless, the 'action' attribute is '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 content-info message as illustrated in the following example. (See <link url='#ns'>Protocol Namespaces</link> regarding issuance of a permanent namespace.)</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'
to='ivr.shakespeare.lit'
id='dtmf1'
type='set'>
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
action='content-info'
action='session-info'
initiator='juliet@capulet.com/balcony'
sid='a73sjjvkla37jfea'>
<dtmf xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns'
@ -91,22 +97,33 @@
<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'
from='juliet@capulet.com/balcony'
to='juliet@capulet.com/balcony'
id='dtmf1'
type='result'/>
]]></example>
<p>If the receiving entity does not understand or cannot process the payload, it MUST return an appropriate XMPP error (such as &unavailable; or &unexpected;).</p>
<p>If the receiving entity does not understand or cannot process the payload, it MUST return an error &feature; with 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'
to='juliet@capulet.com/balcony'
id='dtmf1'
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 RFC 4733' anchor='rfc4733'>
<p>Some applications may want to stream Jingle voice RTP directly to a non-XMPP entity, such as a SIP phone. 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 switches to RFC 4733, a client sends a &lt;dtmf-method/&gt; element, qualified by the 'http://jabber.org/protocol/info/dmtf' namespace as the payload of a Jingle content-info message:</p>
<example caption="Client requests using RFC 4733"><![CDATA[
<p>To request that the voice session switches to RFC 4733, 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'
to='ivr.shakespeare.lit'
id='dtmf2'
type='set'>
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
action='content-info'
action='session-info'
initiator='juliet@capulet.com/balcony'
sid='a73sjjvkla37jfea'>
<dtmf-method xmlns='http://www.xmpp.org/extensions/xep-0181.html#ns' method='rtp'>
@ -114,15 +131,15 @@
</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, it SHOULD send an empty IQ result:</p>
<example caption="Recipient acknowledges request"><![CDATA[
<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 supoprt the requested DTMF method, it MUST reply with a &lt;feature-not-implemented/&gt; error with a DTMF-specific error condition of &lt;unsupported-dtmf-method/&gt;:</p>
<example caption="Recipient refuses request"><![CDATA[
<p>If the recipient does not support the requested DTMF method, it MUST return an error of a &lt;feature-not-implemented/&gt; error with 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'
@ -150,7 +167,7 @@
<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-0180.html#ns" and "http://www.xmpp.org/extensions/xep-0180.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>
<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>