XEP-0152: Reachability Addresses

This document defines an XMPP protocol extension for communicating reachability information related to non-XMPP devices.

WARNING: Consideration of this document has been Deferred by the XMPP Standards Foundation. Implementation of the protocol described herein is not recommended.

Document Information

Series: XEP
Number: 0152
Publisher: XMPP Standards Foundation
Status: Deferred
Type: Standards Track
Version: 0.2
Last Updated: 2006-09-17
Approving Body: XMPP Council
Dependencies: XMPP Core, XMPP IM
Supersedes: None
Superseded By: None
Short Name: reach
Wiki Page: <http://wiki.jabber.org/index.php/Reachability Addresses (XEP-0152)>

Author Information

Legal Notices

Discussion Venue

The preferred venue for discussion of this document is the Standards discussion list: <http://mail.jabber.org/mailman/listinfo/standards>.

Errata may be sent to <editor@xmpp.org>.

Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Conformance Terms

The following keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Table of Contents

1. Introduction

Sometimes it is desirable or necessary to switch from instant messaging (IM) to another real-time communications medium, such as a telephone conversation conducted over the traditional public switched telephone network (PSTN) or more recent Voice over Internet Protocol (VoIP) applications. In order to facilitate switching from IM to telephony or some other medium, a user needs to advertise the address(es) at which they can be reached. There are several possible ways to do this:

• Publish the reachability address(es) in the user's vCard (see vcard-temp [1]); this is convenient, but is not very dynamic (e.g., reachability addresses might change when the user moves to a new conference room in an office building).

• Publish the user's reachability status (but not addresses) as a feature bundle within Entity Capabilities [2] information; this is somewhat dynamic (subscribers can be informed when reachability information is available) but requires every interested subscriber to perform service discovery in order to determine the reachability address(es).

• Send the reachability address(es) within a <presence/> stanza; this option is described in the Presence Broadcast section of this document and is consistent with Section 5.1.2 of RFC 3921 [3] since reachability is one aspect of a user's availability for communication.

• Send reachability address(es) to the appropriate Personal Eventing via Pubsub [4] node; this option is described in the PEP Transport section of this document but may not be available at all service providers.

2. Requirements

This document addresses the following requirements:

• Enable clients to dynamically publish reachability addresses.
• Minimize network traffic.

3. Data Format

The following is an example of the basic data format for reachability addresses:

Example 1. Basic Data Format for Reachability Addresses

<reach xmlns='http://jabber.org/protocol/reach'>
  <addr uri='tel:+1-303-555-1212'/>
  <addr uri='sip:romeo@sipspeare.lit'/>
</reach>
  

When publishing reachability addresses, the <reach/> element MUST contain at least one <addr/> element. Each <addr/> element MUST possess a 'uri' attribute, whose value MUST be the Uniform Resource Identifier (RFC 3986 [5]) or Internationalized Resource Identifier (RFC 3987 [6]) of an alternate communications method for reaching the user.

The <addr/> element MAY contain one or more <desc/> children whose XML character data is a natural-language description of the address; this element SHOULD possess an 'xml:lang' attribute whose value is a language tag that conforms to RFC 4646 [7] (although the default language MAY be specified at the stanza level; see Section 9.1.5 of RFC 3920 [8]). In order to preserve bandwidth, the <desc/> element SHOULD NOT be included when sending reachbility data via presence broadcast, but MAY be included when using personal eventing.

Example 2. Reachability Addresses With Descriptions

<reach xmlns='http://jabber.org/protocol/reach'>
  <addr uri='tel:+1-303-555-1212'>
    <desc xml:lang='en'>New conference room number</desc>
  </addr>
  <addr uri='sip:romeo@sipspeare.lit'>
    <desc xml:lang='en'>My softphone</desc>
  </addr>
</reach>
  

4. Data Transport

As described below, this document specifies two methods of advertising reachability addresses:

• Presence broadcast
• Personal eventing via publish-subscribe (PEP)

This document does not recommend one transport method over the other.

In addition, a contact MAY request a user's reachability addresses using an <iq/> request-response sequence.

<presence from='romeo@montague.net'>
  <reach xmlns='http://jabber.org/protocol/reach'>
    <addr uri='tel:+1-303-555-1212'/>
    <addr uri='sip:romeo@sipspeare.lit'/>
  </reach>
</presence>
    

<presence from='romeo@montague.net' to='juliet@capulet.com'>
  <reach xmlns='http://jabber.org/protocol/reach'>
    <addr uri='tel:+1-303-555-1212'/>
    <addr uri='sip:romeo@sipspeare.lit'/>
  </reach>
</presence>
.
.
.
    

<iq type='set'
    from='romeo@montague.net'
    to='pubsub.shakespeare.lit'
    id='publish1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='http://jabber.org/protocol/reach'>
      <item id='a1s2d3f4g5h6bjeh936'>
        <reach xmlns='http://jabber.org/protocol/reach'>
          <addr uri='tel:+1-303-555-1212'>
            <desc xml:lang='en'>My mobile number</desc>
          </addr>
          <addr uri='sip:romeo@sipspeare.lit'>
            <desc xml:lang='en'>My softphone</desc>
          </addr>
        </reach>
      </item>
    </publish>
  </pubsub>
</iq>
    

<message from='pubsub.shakespeare.lit'
         to='juliet@capulet.com'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='http://jabber.org/protocol/reach'>
      <item id='a1s2d3f4g5h6bjeh936'>
        <reach xmlns='http://jabber.org/protocol/reach'>
          <addr uri='tel:+1-303-555-1212'>
            <desc xml:lang='en'>My mobile number</desc>
          </addr>
          <addr uri='sip:romeo@sipspeare.lit'>
            <desc xml:lang='en'>My softphone</desc>
          </addr>
        </reach>
      </item>
    </items>
  </event>
</message>
    

<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>

<iq to='romeo@montague.net/orchard' from='juliet@capulet.com/balcony' id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    ...
    <feature var='http://jabber.org/protocol/reach'/>
    ...
  </query>
</iq>
    

<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' id='reach1'>
  <reach xmlns='http://jabber.org/protocol/reach'/>
</iq>

<iq to='romeo@montague.net/orchard' from='juliet@capulet.com/balcony' id='reach1'>
  <reach xmlns='http://jabber.org/protocol/reach'>
    <addr uri='tel:+1-303-555-1212'>
      <desc xml:lang='en'>My mobile number</desc>
    </addr>
    <addr uri='sip:romeo@sipspeare.lit'>
      <desc xml:lang='en'>My softphone</desc>
    </addr>
  </reach>
</iq>
    

5. Implementation Notes

To preserve network bandwidth, the sender SHOULD NOT include the <desc/> element unless that information is deemed necessary to enable communication.

A recipient SHOULD attempt communications with reachability addresses in the order that the <addr/> elements appear within the <reach/> element.

6. Internationalization Considerations

If included, the <desc/> element SHOULD possess an 'xml:lang' attribute specifying the language of the human-readable descriptive text for a particular address.

7. Security Considerations

This document introduces no security considerations above and beyond those described in RFC 3920, RFC 3921, and (for the personal eventing transport) XEP-0163.

8. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [10].

9. XMPP Registrar Considerations

10. XML Schema

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://jabber.org/protocol/reach'
    xmlns='http://jabber.org/protocol/reach'
    elementFormDefault='qualified'>

  <xs:element name='reach'>
    <xs:complexType>
      <xs:sequence>
        <xs:element ref='addr' minOccurs='0' maxOccurs='unbounded'/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:element name='address'>
    <xs:complexType>
      <xs:sequence>
        <xs:element ref='desc' minOccurs='0' maxOccurs='unbounded'/>
      </xs:sequence>
      <xs:attribute name='uri' use='required' type='xs:anyURI'/>
    </xs:complexType>
  </xs:element>

  <xs:element name='desc' type='xs:string'/>

</xs:schema>
  

Notes

Revision History

END