From f6197e2174d183932200bb8fe4aa0842cd94fa41 Mon Sep 17 00:00:00 2001 From: Peter Saint-Andre Date: Thu, 7 Nov 2013 16:59:57 -0800 Subject: [PATCH] inbox items --- inbox/rayo-cpa.xml | 326 +++++++++++++++++++++++++++++++++ inbox/rayo-fax.xml | 441 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 767 insertions(+) create mode 100644 inbox/rayo-cpa.xml create mode 100644 inbox/rayo-fax.xml diff --git a/inbox/rayo-cpa.xml b/inbox/rayo-cpa.xml new file mode 100644 index 00000000..7da1b645 --- /dev/null +++ b/inbox/rayo-cpa.xml @@ -0,0 +1,326 @@ + + +%ents; +]> + + +
+ Rayo CPA + This specification defines an extension to the Rayo protocol (XEP-0327) to provide provision for performing Call Progress Analysis on a call under the control of a Rayo client. + &LEGALNOTICE; + NOT_YET_ASSIGNED + Experimental + Standards Track + Standards + Council + + XMPP Core + XEP-0327 Rayo + + + + NOT_YET_ASSIGNED + + Ben + Langfeld + ben@langfeld.me + ben@langfeld.me + http://langfeld.me + + + 0.0.1 + 2013-10-02 + bl +

First draft.

 + +
+ +

Rayo allows for the third-party control of media sessions such as telephone calls. A common requirement in telephony applications is to establish the progress characteristics of the session, such as dtmf, fax or modem tones, or to differentiate between a human and an answering machine. This specification extends the core Rayo specification, and specifically its Input component to describe a protocol for establishing such progress analysis and gathering its results.

+ + + +
+ +
CPA
+
Call progress analysis.
+ +
+ + + +

This section describes the form, function and order of Rayo stanzas sent across the wire, and the circumstances in which they apply and/or may arise.

+ +

CPA is achieved as a special case of the core input component. All rules regarding component execution and the input component in particular apply from the core specification. When a call's controlling party wishes to begin detection of signals from the suported set, it SHOULD begin an input component with the mode attribute set as 'cpa'.

+ +

The grammars supplied determine the types of signal detected and parameters applied to their detection. The grammars MUST be referenced by URI in the format described below. If a Rayo server supports this specification, it MUST invoke its supported CPA function using the parameters provided from the grammars; if it does not support this specification or any of the supplied parameters within the grammar, it MUST raise an error according to the rules in the core specification.

+ + + + + + + + ]]> + +

The server MUST validate that it has appropriate resources/mechanisms to collect the requested signals before acknowledging the component creation.

+ + +

If the meta-attribute named 'terminate' is set to true in the grammar, the component MUST terminate on the first signal match it detects. If it is set to false, signals MUST be reported as events until the component is instructed to stop.

+ + + + + ]]> + + + +

The input completion reason MUST be one of the supported reasons from the core specification or a signal, indicating that the CPA engine detected one of the requested signals. Any signals other than those requested by the input grammar should be ignored.

+ + + + + + + ]]> + + + + +

The grammar URI declares the signal type of interest and the parameters which apply to their detection. The URI should be composed of a URN from the following list of allowed signal types, and parameters to modify their detection as a query string. The names and allowed values of these parameters are implementation specific. Servers MUST support one reserved parameter named 'terminate', whose value indicates the termination behaviour of the component on signal detection as described above.

+ + + +

Describes a detected signal.

+

The attributes of the <grammar/> element are as follows.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDefinitionPossible ValuesDefaultInclusion
typeIndicates the type of signal detected.Any URI value from the listed signal typesnoneREQUIRED
durationIndicates the duration of the received signal in millisecondsAn integer value in milliseconds.noneOPTIONAL
valueIndicates the value of the signal received if applicable.For dtmf tones it is the digit detected, for speech may be human|machine|notsure and for beeps may be a frequency in Hz.noneOPTIONAL
+ + + +

Signal types may be one of the following:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
URIDescription
urn:xmpp:rayo:cpa:beep:1Detect a beep.
urn:xmpp:rayo:cpa:dtmf:1Detect DTMF tones.
urn:xmpp:rayo:cpa:speech:1Detect speech and decide human or machine.
urn:xmpp:rayo:cpa:fax-ced:1Detect a fax CED tone.
urn:xmpp:rayo:cpa:fax-cng:1Detect a fax CNG tone.
urn:xmpp:rayo:cpa:ring:1Detect a ringing tone.
urn:xmpp:rayo:cpa:busy:1Detect a busy tone.
urn:xmpp:rayo:cpa:congestion:1Detect a congestion tone.
urn:xmpp:rayo:cpa:sit:1Detect a Special Information Tone.
urn:xmpp:rayo:cpa:modem:1Detect a modem tone.
urn:xmpp:rayo:cpa:offhook:1Detect an off-hook tone.
+ + + +

STRONGLY RECOMMENDED.

+ + +

If a Rayo server supports Rayo CPA, it MUST advertise that fact by returning a feature of "urn:xmpp:rayo|cpa:0" &VNOTE; in response to a &xep0030; information request.

+ + + + ]]> + + + + + + + ]]> +

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.

+ + +

A server MUST document any cases where its behaviour differs from that in this specification (such as lack of support for particular options/components/etc) and return an error whenever a command is not understood. A server MUST NOT silently ignore any instructions.

+ + +

None

+ + +

This document requires no interaction with &IANA;.

+ + + +

This specification defines the following XML namespaces:

+
    +
  • urn:xmpp:rayo:cpa:1
    • +
  • urn:xmpp:rayo:cpa:beep:1
    • +
  • urn:xmpp:rayo:cpa:dtmf:1
    • +
  • urn:xmpp:rayo:cpa:speech:1
    • +
  • urn:xmpp:rayo:cpa:fax-ced:1
    • +
  • urn:xmpp:rayo:cpa:fax-cng:1
    • +
  • urn:xmpp:rayo:cpa:ring:1
    • +
  • urn:xmpp:rayo:cpa:busy:1
    • +
  • urn:xmpp:rayo:cpa:congestion:1
    • +
  • urn:xmpp:rayo:cpa:sit:1
    • +
  • urn:xmpp:rayo:cpa:modem:1
    • +
  • urn:xmpp:rayo:cpa:offhook:1
    • +
+

The ®ISTRAR; includes the foregoing namespaces in its registry at &NAMESPACES;, as governed by &xep0053;.

+ + +

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

+ + + + + + + + + + The protocol documented by this schema is defined at http://rayo.org/xep + + + + + + + + Describes a detected signal. + + + + + + + + Indicates the type of signal detected. + + + + + + + + + + + + + + + + + + + + + + Indicates the duration of the received signal in milliseconds + + + + + + + Indicates the value of the signal received if applicable. For dtmf tones it is the digit detected, for speech may be human|machine|notsure and for beeps may be a frequency in Hz. + + + + + + + + ]]> + + + +

The authors would like to acknowledge the input of teams at Tropo Inc, Mojo Lingo and Grasshopper in the development of this specification.

+ +

Specific individuals who have contributed to the specification or to software significant to its completion include:

+
    +
  • Ben Langfeld
    • +
  • Chris Rienzo
    • +
  • Martín Pérez
    • +
+ + diff --git a/inbox/rayo-fax.xml b/inbox/rayo-fax.xml new file mode 100644 index 00000000..7154e1b3 --- /dev/null +++ b/inbox/rayo-fax.xml @@ -0,0 +1,441 @@ + + +%ents; +]> + + +
+ Rayo Fax + This specification defines an extension to the Rayo protocol (XEP-0327) to provide provision for sending and receiving faxcimilies via a call under the control of a Rayo client. + &LEGALNOTICE; + NOT_YET_ASSIGNED + Experimental + Standards Track + Standards + Council + + XMPP Core + XEP-0327 Rayo + XEP-xxxx Rayo CPA + + + + NOT_YET_ASSIGNED + + Ben + Langfeld + ben@langfeld.me + ben@langfeld.me + http://langfeld.me + + + 0.0.1 + 2013-10-02 + bl +

First draft.

 + +
+ +

Rayo allows for the third-party control of media sessions such as telephone calls. A common requirement in telephony applications providing backward compatability with legacy systems is to support sending and receiving faxes. This specification extends the core Rayo specification, to describe a protocol for this use case.

+ + +

This section describes the form, function and order of Rayo stanzas sent across the wire, and the circumstances in which they apply and/or may arise.

+ + +

A Rayo client may utilise Rayo CPA to establish a fax CNG tone before initiating fax receipt using the receivefax component described below.

+ +

The receivefax component accepts a fax from a caller, stores it, and makes it available to Rayo clients. The component is created using a <receivefax/> command.

+ + + + + ]]> + +

The server MUST validate that it has apropriate resources/mechanisms to receive the fax before acknowledging the component creation.

+ + +

The receivefax component does not implement any intermediary commands.

+ + + +

The receivefax component does not provide any intermediate events.

+ + + +

The receivefax completion reason MUST be one of the core Rayo reasons or finish (indicating that the document was fully received). Receivefax component completion provides a fax element only when a document was successfully received.

+ +

The server MUST present the fax for consumption by the client by way of fax meta-data on the complete reason, including a URI at which the document may be fetched. It MUST provide url, resolution, file size & page count data as specified on the fax element. In cases of partial receipt of a fax, a fax element MAY be returned in addition to the error completion reason.

+ + + + + + + + ]]> + + + + +

Sending faxes can be achieved by using the Sendfax component. A conformant server MUST support image/tiff documents, and MAY also support others. A conformant server MUST support fetching documents via an HTTP URL and MAY support other URL schemes.

+ + + + + + + ]]> + +

Additionally, a sendfax component MAY include in its completion reason one or more <metadata/> elements describing the result of transmitting the document, like so:

+ + + + + + + + ]]> + + + + +

Instructs the server to begin receiving a fax.

+

The <receivefax/> element MUST be empty.

+

The <receivefax/> element has no attributes.

+ + + +

Instructs the server to begin transmitting a fax.

+

The <sendfax/> element MUST be empty.

+

The <sendfax/> element has no attributes.

+ + + +

Provides the result of a received fax, as a reference to its location.

+

The <fax/> element MUST be empty.

+

The attributes of the <fax/> element are as follows.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDefinitionPossible ValuesInclusion
urlIndicates the URL at which the fax is made available.A valid URI.REQUIRED
resolutionIndicates the resolution of the received fax.A string in MxN format, where M and N are integers in pixels.REQUIRED
pagesIndicates the number of pages in the received fax.An integer.REQUIRED
sizeIndicates the filesize of the received fax.A positive integer in bytes.REQUIRED
+ + + +

Provides data for a document to be sent as a fax.

+

The <document/> element MUST be empty.

+

The attributes of the <document/> element are as follows.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDefinitionPossible ValuesInclusion
urlIndicates the URL at which the document to send is available.A valid URI.REQUIRED
identityIndicates the identity from which the fax should appear to be sent.A phone number string in E.164 format.OPTIONAL
headerThe header line to add to each page of the transmitted fax.A string.OPTIONAL
pagesThe (set of) range of pages of the document to transmit.A string (or set of strings separated by ',') in the format M[-N], where M and N are integers and the dash and second integer are optional. The set is combinatory and dash-separated integers signify a range of pages. The index is one-based.OPTIONAL
+ + + +

Provides implementation-specific key-value pairs of metadata regarding the transmission or receipt of a fax document.

+

The <metadata/> element MUST be empty.

+

The attributes of the <metadata/> element are as follows.

+ + + + + + + + + + + + + + + + +
AttributeDefinitionInclusion
nameA token giving the name by which the metadata may be known.REQUIRED
valueThe string value of the named metadata.REQUIRED
+ + + +

Indicates that the component came to an end due to the document being received successfully.

+

The <finish/> element MUST be empty.

+

The <finish/> element has no attributes.

+ + + +

If a Rayo server supports Rayo Fax, it MUST advertise that fact by returning a feature of "urn:xmpp:rayo:fax:1" &VNOTE; in response to a &xep0030; information request.

+ + + + ]]> + + + + + + + ]]> +

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.

+ + +

A server MUST document any cases where its behaviour differs from that in this specification (such as lack of support for particular options/components/etc) and return an error whenever a command is not understood. A server MUST NOT silently ignore any instructions.

+ + +

None

+ + +

This document requires no interaction with &IANA;.

+ + + +

This specification defines the following XML namespaces:

+
    +
  • urn:xmpp:rayo:fax:1
    • +
  • urn:xmpp:rayo:fax:complete:1
    • +
+

The ®ISTRAR; includes the foregoing namespaces in its registry at &NAMESPACES;, as governed by &xep0053;.

+ + +

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

+ + + + + + + + + + The protocol documented by this schema is defined at http://rayo.org/xep + + + + + + + + Instructs the server to begin receiving a fax. + + + + + + + + + Instructs the server to begin transmitting a fax. + + + + + + + + + Provides the result of a received fax, including a reference to its location. + + + + + + Indicates the URL at which the document to send is available. + + + + + + + Indicates the identity from which the fax should appear to be sent. + + + + + + + The header line to add to each page of the transmitted fax. + + + + + + + A string (or set of strings separated by ',') in the format M[-N], where M and N are integers and the dash and second integer are optional. The set is combinatory and dash-separated integers signify a range of pages. The index is one-based. + + + + + + ]]> + + + + + + + + The protocol documented by this schema is defined at http://rayo.org/xep + + + + + + + + Provides the result of a received fax, including a reference to its location. + + + + + + Indicates the URL at which the fax is made available. + + + + + + + Indicates the resolution of the received fax in MxN format, where M and N are integers in pixels. + + + + + + + Indicates the number of pages in the received fax. + + + + + + + Indicates the filesize (in bytes) of the received fax. + + + + + + + + + + A token giving the name by which the metadata may be known. + + + + + + + The string value of the named metadata. + + + + + + + + + + Indicates that the component came to an end due to the document being received successfully. + + + + + ]]> + + + +

The authors would like to acknowledge the input of teams at Mojo Lingo and Grasshopper in the development of this specification.

+ +

Specific individuals who have contributed to the specification or to software significant to its completion include:

+
    +
  • Ben Langfeld
    • +
  • Chris Rienzo
    • +
+ +