<abstract>This document defines an XMPP protocol extension that enables a user to add a non-IM user to a waiting list and be informed when the contact creates an IM account.</abstract>
<remark>Clarified alternate flow for main use case; corrected order of errors and JID pushes; specified that item removal is always the responsibility of the IM user; removed remote-server-not-found example (use item-not-found instead).</remark>
</revision>
<revision>
<version>1.2</version>
<date>2006-01-24</date>
<initials>psa</initials>
<remark>Adjusted remote-server-timeout flow to recommend IQ result followed by JID push message.</remark>
</revision>
<revision>
<version>1.1</version>
<date>2005-11-30</date>
<initials>psa</initials>
<remark>Harmonized root element specification with implemented usage, reversing change made in version 0.5.</remark>
</revision>
<revision>
<version>1.0</version>
<date>2005-08-26</date>
<initials>psa</initials>
<remark>Per a vote of the Jabber Council, advanced status to Active.</remark>
</revision>
<revision>
<version>0.6</version>
<date>2005-08-16</date>
<initials>psa</initials>
<remark>Added error case for remote server timeout; specified client and service responsibilities regarding removal of waiting list items in error cases.</remark>
</revision>
<revision>
<version>0.5</version>
<date>2005-05-16</date>
<initials>psa</initials>
<remark>Corrected schema and IQ examples by changing root element for namespace from <query/> to <waitlist/> (this had been used for message examples but not IQ examples).</remark>
<remark>Changed document type to Informational; corrected Remote Server Error example to use &remoteserver; rather than &unavailable;; added service discovery identity to XMPP Registrar Considerations; corrected text regarding registration of service discovery features; corrected some small errors in the text, examples, and schema.</remark>
<remark>Corrected error syntax used when Contact URI is not handled by any InteropPartner.</remark>
</revision>
<revision>
<version>0.2</version>
<date>2004-09-03</date>
<initials>psa</initials>
<remark>Added alternate flow for situation in which Contact URI is not handled by any InteropPartner; changed headline message type for JID pushes from SHOULD to MAY; clarified semantics of item ID; added name child of item; corrected and updated the XML schema; updated examples to use XMPP error conditions.</remark>
<remark>Fixed several small errors in the examples.</remark>
</revision>
<revision>
<version>0.0.9</version>
<date>2003-08-22</date>
<initials>psa</initials>
<remark>Specified optional use of message type 'headline'; fixed one small error in the examples.</remark>
</revision>
<revision>
<version>0.0.8</version>
<date>2003-07-23</date>
<initials>psa</initials>
<remark>Changed client-server push mechanism to use <message/> rather than <iq/>, since client may not be online; allowed IQ result to include waitlist information if known; added more detailed disco#info lookup to support discovery of URI types supported.</remark>
</revision>
<revision>
<version>0.0.7</version>
<date>2003-07-02</date>
<initials>psa</initials>
<remark>Modified to use a generic <uri scheme=''/> element.</remark>
</revision>
<revision>
<version>0.0.6</version>
<date>2003-06-26</date>
<initials>psa</initials>
<remark>Refactored protocol to use IQ sets that are "pushed" to the component or client (similar to XMPP rosters); added service discovery and agents support; made text more generic; simplified error handling; change name to "Waiting Lists".</remark>
</revision>
<revision>
<version>0.0.5</version>
<date>2003-06-24</date>
<initials>psa</initials>
<remark>Added remove use case and protocol; added XML schema.</remark>
</revision>
<revision>
<version>0.0.4</version>
<date>2003-06-19</date>
<initials>psa</initials>
<remark>Specified protocol.</remark>
</revision>
<revision>
<version>0.0.3</version>
<date>2003-06-18</date>
<initials>psa</initials>
<remark>Simplified requirements; defined main use case.</remark>
<p>An IM user may want to be informed when a contact creates an IM account. If the user knows some information about the contact (e.g., a phone number or email address), the user's service can use that information to place the contact on a "waiting list", then inform the user when the contact creates an IM account. This document defines an extension to &rfc3920; and &rfc3921; that enables such "waiting list" functionality, including the ability to add contacts on other domains if service providers agree to interoperate (e.g., to add a contact who uses a different mobile telephony service provider).</p>
<p><em>Note: The protocol defined herein is currently in use at several large service providers in Europe. Others are welcome to use the protocol.</em></p>
</section1>
<section1topic="Glossary"anchor='glossary'>
<tablecaption="Terms Used">
<tr>
<th>Term</th>
<th>Definition</th>
</tr>
<tr>
<td>Contact</td>
<td>A person with whom an IM User seeks to communicate, identified by a URI such as <tel:PhoneNumber> (see &rfc3966;) or <mailto:EmailAddress> (see &rfc2368;).</td>
</tr>
<tr>
<td>Customer</td>
<td>A person who is contracted for services with a ServiceProvider.</td>
</tr>
<tr>
<td>IM User</td>
<td>Any Customer who has registered for instant messaging services.</td>
</tr>
<tr>
<td>InteropPartner</td>
<td>Any company that agrees to interoperate using the protocol defined herein.</td>
</tr>
<tr>
<td>JID</td>
<td>The unique identifier of an IM User in the XMPP protocol. Outside the context of an IM session, a JID is of the form &BAREJID; ("bare JID"); within the context of an IM session, a JID is of the form &FULLJID; ("full JID").</td>
</tr>
<tr>
<td>ServiceProvider</td>
<td>A company that provides telephony or email services to a Customer.</td>
</tr>
<tr>
<td>URI</td>
<td>A Uniform Resource Identifier as defined in &rfc3986;. Specific URI schemes that may be useful in this specification include 'tel:', 'mailto:', and 'sip:', but any URI scheme may be used.</td>
</tr>
<tr>
<td>Waiting List</td>
<td>A list of Contacts whom an entity (IM User or InteropPartner) is waiting to hear about regarding their status as instant messaging users.</td>
</tr>
<tr>
<td>WaitingListService</td>
<td>An XMPP service that maintains Waiting lists for IM Users and/or InteropPartners.</td>
</tr>
</table>
</section1>
<section1topic="Requirements"anchor='reqs'>
<p>This protocol is designed so that an IM User can:</p>
<li>WaitingListService returns ¬found; error to IM User.</li>
<li>Use Case Ends unsuccessfully.</li>
</ol>
</li>
</ol>
</section3>
</section2>
<section2topic="IM User Adds Contact to WaitingList"anchor='imuser-add'>
<p>An IM User may know a URI for a Contact (e.g., a phone number or email address) but not the Contact's JID. In order to subscribe to the Contact's presence or otherwise communicate with the Contact over an instant messaging system, the IM User first needs to discover the Contact's JID based on a URI for the Contact. However, the Contact may not yet have an IM account. Because the IM User may therefore need to wait until the Contact creates an account, the IM User needs to add the Contact to a WaitingList. The activity flow is as follows:</p>
<li>ServiceProvider's WaitingListService removes item from WaitingList at InteropPartner's WaitingListService.</li>
<li>Use Case Ends unsuccessfully.</li>
</ol>
</li>
</ol>
</section3>
</section2>
<section2topic="IM User Removes Contact from WaitingList"anchor='imuser-remove'>
<p>An IM User should remove a contact from the WaitingList after the <linkurl='#imuser-add'>IM User Adds Contact to WaitingList</link> use case ends (either successfully or unsuccessfully), and may remove a contact from the WaitingList at any other time.</p>
<section2topic="IM User Interaction With WaitingListService"anchor='protocol-imuser'>
<p>
<em>This section of the document is provided for the sake of domains that implement XMPP as their local protocol; domains that implement another protocol will use their service-specific protocol to complete the user-to-domain interaction.</em>
</p>
<section3topic="IM User Retrieves Current WaitingList"anchor='protocol-imuser-retrieve'>
<p>It is RECOMMENDED for an IM User's client to retrieve the WaitingList immediately after logging in. However, first it must discover its local WaitingListService. An IM User MAY use either &xep0030; or the deprecated &xep0094; protocol.</p>
<p>The WaitingListService SHOULD return detailed information about the service it provides, including the URI schemes it supports (see also the <linkurl='#registrar-features'>Service Discovery Features</link> section of this document).</p>
<p>Once an IM User has discovered the WaitingListService, the user's client SHOULD request its current Waiting List. This is done by sending an IQ-get to the WaitingListService containing an empty <query/> element qualified by the 'http://jabber.org/protocol/waitinglist' namespace:</p>
<examplecaption="IM User Requests its Current WaitingList"><![CDATA[
<p>Each ItemID MUST be unique within the scope of the client's WaitingList items. The value of the ItemID is an opaque string; an implementation MAY assign semantic meaning to the ItemID (e.g., id="John Smith (mobile)" rather than id="12345"), but such meaning is implementation-specific and outside the scope of the protocol defined herein. The user MAY include a <name/> element containing a natural-language name for the Contact.</p>
<p>The WaitingList MAY contain an item for which a JID has been discovered.</p>
<examplecaption="IM User Asks for its WaitingList including Newly Discovered JID"><![CDATA[
<p>Once an IM User's client has discovered the WaitingListService and requested the user's WaitingList, the user can add Contacts to the WaitingList based on the Contact's URI. (Note: This document uses the example of phone numbers via the 'tel' URI scheme, but the same rules apply to WaitingList items based on email addresses or other URI schemes.)</p>
<p>If the IM User provided a URI whose scheme is not supported, WaitingListService MUST return a &badrequest; error to the IM User and MUST NOT add the Contact to the WaitingList.</p>
<examplecaption='WaitingListService Returns &badrequest; Error to IM User'><![CDATA[
<p>If the IM User included a JID in the request, WaitingListService MUST return a &badrequest; error to IM User and MUST NOT add the Contact to the WaitingList. (Note: A WaitingListService MUST NOT return a non-XMPP URI to an IM User based on the Contact's JID; see the <linkurl='#security'>Security Considerations</link> section of this document.)</p>
<examplecaption='WaitingListService Returns &badrequest; Error to IM User'><![CDATA[
<p>If the IM User provided an invalid URI (e.g., a phone number with too many digits or an email address with no '@' character), WaitingListService MUST return a ¬acceptable; error to the IM User and MUST NOT add the Contact to the WaitingList.</p>
<examplecaption='WaitingListService Returns ¬acceptable; Error to IM User'><![CDATA[
<p>If one of the foregoing errors was generated (all of which have a type of "modify"), IM User SHOULD modify the request and re-submit it.</p>
<p>If none of the "modify" errors was generated, WaitingListService MUST inform the IM User that the request was successfully received, including a unique ID number for the new WaitingList item.</p>
<examplecaption="WaitingListService Informs IM User that Request was Received"><![CDATA[
<p>If none of the "modify" errors was generated and WaitingListService knows Contact JID when the IQ result is returned to the user (e.g., because Contact is served by ServiceProvider), WaitingListService MAY include the WaitingList item in the IQ result: <note>Even if WaitingListService returns Contact JID in the IQ-result, it MUST also send a "JID push" message.</note></p>
<examplecaption="WaitingListService Returns IQ Result to IM User (With Contact JID)"><![CDATA[
<p>If none of the "modify" errors was generated and WaitingListService does not know Contact JID when the IQ result is returned to the user, it needs to contact InteropPartners in order to determine if the Contact is associated with one of the InteropPartners. Thus before it returns the Contact JID to the IM User, it needs to wait for the one of the InteropPartners to return Contact JID or for all of the InteropPartners to return errors.</p>
<p>If all of the InteropPartners return an error of type "cancel" (typically ¬found; and/or ¬authorized;) to WaitingListService, WaitingListService MUST return an ¬found; error (or local equivalent) to the IM User (and IM User SHOULD complete <linkurl='#imuser-remove'>IM User Removes Contact from WaitingList</link> use case).</p>
<examplecaption='WaitingListService Returns ¬found; Error to IM User'><![CDATA[
<p>If the connection to at least one of the InteropPartners times out (a &timeout; error), WaitingListService MUST return an IQ-result as described above (indicating that the request was received) and resend the request to the InteropPartners that timed out. If connections continue to time out (over some configurable time period and for some configurable number of retries), WaitingListService SHOULD then return a &timeout; error to IM User via a "JID push" message as shown below.</p>
<p>If InterPartner's WaitingListService knows the Contact JID, it sends it to ServiceProvider's WaitingListService as shown in the <linkurl='#protocol-service-add'>ServiceProvider's WaitingListService Adds Contact to WaitingList</link> section of this document.</p>
<p>If WaitingListService knows Contact JID (or learns Contact JID from InteropPartner), it MUST inform IM User through a "JID push" message, which consists of a message stanza that contains a <waitlist/> element qualified by the 'http://jabber.org/protocol/waitinglist' namespace:
<note>When waiting list information is included in a message stanza, the root element for the 'http://jabber.org/protocol/waitinglist' namespace is <waitlist/> rather than <query/> (as used within IQ stanzas). This disparity is historical and tracks the protocol syntax that was most widely implemented, as defined in version 0.4 of this specification. In the interest of interoperability, the IQ usage was changed back to <query/> in version 1.1 of this specification. If this document were not historical, the root element usage would be harmonized to use only the <waitlist/> element.</note>
<p>Note: The JID push uses an XMPP <message/> stanza because the WaitingListService has no knowledge of the user's presence and therefore cannot assume that an &IQ; stanza will be received by the user at a specific resource.</p>
<p>If WaitingListService learns that Contact's URI is not handled by any InteropPartner, it MUST inform IM User through a "JID push" message:</p>
<examplecaption="WaitingListService Informs IM User that No InteropPartner Handles Contact's URI"><![CDATA[
<p>After receiving the "JID push" message, IM User SHOULD complete the <linkurl='#imuser-remove'>IM User Removes Contact from WaitingList</link> use case.</p>
</section3>
<section3topic="IM User Removes Contact from WaitingList"anchor='protocol-imuser-remove'>
<p>In order to remove the item from the WaitingList, the IM User MUST complete the <linkurl='#imuser-remove'>Remove Contact from WaitingList</link> use case.</p>
<examplecaption="IM User Sends Removal Request to WaitingListService"><![CDATA[
<section2topic="WaitingListService Interaction With InteropPartners"anchor='protocol-service'>
<p>
<em>This section of the document describes the inter-domain protocol for communication between WaitingListServices. The protocol defined in this section MUST be implemented by ServiceProviders.</em>
</p>
<p>A ServiceProvider's WaitingListService MUST be configured with a "whitelist" of InteropPartner's WaitingListServices with which it communicates. Therefore service discovery SHOULD NOT be necessary. However, if necessary it MAY use either the <cite>Agent Information</cite> protocol or the <cite>Service Discovery</cite> protocol as described in the following examples.</p>
<p>Note: The InteropPartner's WaitingListService is not required to be hosted by InteropPartner, and could be hosted by a third party (e.g., a neutral phone number translation service). In this case, InteropPartner would simply advertise 'waitlist.third-party.com' as its WaitingListService.</p>
<section3topic="ServiceProvider's WaitingListService Retrieves Current WaitingList"anchor='protocol-service-retrieve'>
<examplecaption="ServiceProvider Discovers InteropPartner's WaitingListService by Sending Agent Information Request to InteropPartner"><![CDATA[
<iqtype='get'
from='waitlist.service-provider.com'
to='interop-partner.com'
id='agent2'>
<queryxmlns='jabber:iq:agents'/>
</iq>
]]></example>
<examplecaption="InteropPartner Returns Address of its WaitingListService"><![CDATA[
<iqtype='result'
from='interop-partner.com'
to='waitlist.service-provider.com'
id='agent2'>
<queryxmlns='jabber:iq:agents'>
...
<agentjid='waitlist.interop-partner.com'>
<name>Waiting List Service</name>
<service>waitinglist</service>
</agent>
...
</query>
</iq>
]]></example>
<examplecaption="ServiceProvider Discovers InteropPartner's WaitingListService by Sending Service Discovery Request to InteropPartner"><![CDATA[
<section3topic="ServiceProvider's WaitingListService Adds Contact to WaitingList"anchor='protocol-service-add'>
<p>Once a ServiceProvider's WaitingListService has discovered the InteropPartner's WaitingListService and requested its WaitingList, the ServiceProvider's WaitingListService can add items to its WaitingList based on URI.</p>
<examplecaption="ServiceProvider's WaitingListService Adds New Item to WaitingList"><![CDATA[
<p>If Contact's URI is not associated with a person served by this InteropPartner, the InteropPartner MUST return an ¬found; error to the ServiceProvider.</p>
<examplecaption='InteropPartner Returns ¬found; Error to ServiceProvider'><![CDATA[
<p>If ServiceProvider's WaitingListService receives ¬authorized; and/or ¬found; errors from all InteropPartners, it returns a ¬found; error to IM User:</p>
<examplecaption='WaitingListService Returns ¬found; Error to IM User'><![CDATA[
<p>If Contact's URI is associated with a person served by this InteropPartner, InteropPartner MUST return acknowledgement of the WaitingList addition to the ServiceProvider's WaitingListService.</p>
<p>If Contact is an IM User served by InteropPartner, InteropPartner's WaitingListService pushes Contact's JID to ServiceProvider's WaitingListService.</p>
<examplecaption="InteropPartner's WaitingListService Pushes Contact's JID to ServiceProvider's WaitingListService"><![CDATA[
<examplecaption="ServiceProvider's WaitingListService Acknowledges Receipt of JID Push"><![CDATA[
<iqtype='result'
from='waitlist.service-provider.com'
to='waitlist.interop-partner.com'
id='jidpush1'/>
]]></example>
<p>After receiving acknowledgement (but not before), InteropPartner's WaitingListService MUST remove that item from the WaitingList for the ServiceProvider's WaitingListService.</p>
</section3>
<section3topic="ServiceProvider's WaitingListService Removes Contact from WaitingList"anchor='protocol-service-remove'>
<examplecaption="ServiceProvider Requests Removal of Item from WaitingList"><![CDATA[
<p>If item exists on WaitingList, InteropPartner's WaitingListService removes item from list and returns result to ServiceProvider's WaitingListService.</p>
<examplecaption="InteropPartner Returns Result to ServiceProvider"><![CDATA[
<iqtype='result'
from='waitlist.interop-partner.com'
to='waitlist.service-provider.com'
id='remove2'/>
]]></example>
<p>If item does not exist on WaitingList, InteropPartner's WaitingListService MUST return an ¬found; error to the ServiceProvider's WaitingListService.</p>
<examplecaption='InteropPartner Returns ¬found; Error to ServiceProvider'><