%ents; ]>
Waiting Lists 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. &LEGALNOTICE; 0130 Deprecated Historical Standards XMPP Core XMPP IM XEP-0094 XEP-0030 waitinglist http://www.xmpp.org/schemas/waitinglist.xsd 2012-10-18 &stpeter; Yehezkel Dallal yehezkeld@followap.com Alexandre Nolle anolle@francetelecom.com Jean-Louis Seguineau jean-louis.seguineau@antepo.com jlseguineau@im.antepo.com Mark Troyer mtroyer@jabber.com mtroyer@corp.jabber.com &val; 1.4.1 2021-03-04 mw

Cross-document editorial adjustments for inclusive language.

 1.4 2012-04-18 psa

Changed status to Deprecated, per a vote of the XMPP Council.

 1.3 2006-09-13 psa 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). 1.2 2006-01-24 psa Adjusted remote-server-timeout flow to recommend IQ result followed by JID push message. 1.1 2005-11-30 psa Harmonized root element specification with implemented usage, reversing change made in version 0.5. 1.0 2005-08-26 psa Per a vote of the Jabber Council, advanced status to Active. 0.6 2005-08-16 psa Added error case for remote server timeout; specified client and service responsibilities regarding removal of waiting list items in error cases. 0.5 2005-05-16 psa 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). 0.4 2005-04-01 psa 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. 0.3 2004-09-27 psa Corrected error syntax used when Contact URI is not handled by any InteropPartner. 0.2 2004-09-03 psa 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. 0.1 2004-03-18 psa Initial version. 0.0.10 2003-09-03 psa Fixed several small errors in the examples. 0.0.9 2003-08-22 psa Specified optional use of message type 'headline'; fixed one small error in the examples. 0.0.8 2003-07-23 psa 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. 0.0.7 2003-07-02 psa Modified to use a generic <uri scheme=''/> element. 0.0.6 2003-06-26 psa 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". 0.0.5 2003-06-24 psa Added remove use case and protocol; added XML schema. 0.0.4 2003-06-19 psa Specified protocol. 0.0.3 2003-06-18 psa Simplified requirements; defined main use case. 0.0.2 2003-06-16 psa Converted to XML format; formalized use case definitions; minor editorial changes. 0.0.1 2003-06-10 an First draft.

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 &xmppcore; and &xmppim; 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).

Note: The protocol defined herein is currently in use at several large service providers in Europe. Others are welcome to use the protocol.
Contact
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;).
Customer
A person who is contracted for services with a ServiceProvider.
IM User
Any Customer who has registered for instant messaging services.
InteropPartner
Any company that agrees to interoperate using the protocol defined herein.
JID
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").
ServiceProvider
A company that provides telephony or email services to a Customer.
URI
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.
Waiting List
A list of Contacts whom an entity (IM User or InteropPartner) is waiting to hear about regarding their status as instant messaging users.
WaitingListService
An XMPP service that maintains Waiting lists for IM Users and/or InteropPartners.

This protocol is designed so that an IM User can:

  1. Request the user's current Waiting List
  2. Add a Contact to a local WaitingList (based on some URI associated with the Contact)
  3. Receive notification from a local WaitingListService if the Contact has (or subsequently creates) an IM account
  4. Remove a Contact from the Waiting List

In addition, this protocol is designed so that a ServiceProvider can:

  1. Request the service's current WaitingList
  2. Add a Contact to a WaitingList at an InteroPartner (based on some URI associated with the Contact)
  3. Receive notification from the InteropPartner if the Contact has (or subsequently creates) an IM account
  4. Remove a Contact from the Waiting List

Before adding or removing Contacts from its WaitingList, an IM User SHOULD retrieve its current WaitingList. The activity flow is as follows:

  1. IM User discovers WaitingListService hosted by ServiceProvider [A1]; it is RECOMMENDED to do this immediately after logging in.
  2. IM User requests current WaitingList from WaitingListService.
  3. WaitingListService returns WaitingList to IM User, including any items for which JIDs have been discovered. [A2]
  1. ServiceProvider does not host a WaitingListService:
    1. Use Case Ends unsuccessfully.
  2. IM User does not have a Waiting List:
    1. WaitingListService returns ¬found; error to IM User.
    2. Use Case Ends unsuccessfully.

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:

  1. IM User completes IM User Retrieves Current WaitingList use case.
  2. IM User requests addition of Contact to WaitingList based on Contact's URI.
  3. WaitingListService determines that the URI scheme is supported. [A1]
  4. WaitingListService determines that the information provided is a valid URI for that URI scheme. [A2]
  5. WaitingListService determines that Contact's URI does not belong to a person served by ServiceProvider. [A3]
  6. WaitingListService acknowledges addition of Contact to IM User's WaitingList.
  7. WaitingListService discovers WaitingListServices hosted by one or more InteropPartners.
  8. WaitingListService queries one or more InteropPartner's WaitingListServices for JID associated with URI.
  9. InteropPartner's WaitingListService determines that Contact's URI belongs to a person served by that partner. [A4]
  10. InteropPartner's WaitingListService determines that Contact is an IM User. [A5]
  11. InteropPartner's WaitingListService informs ServiceProvider's WaitingListService of JID associated with Contact's URI. [A6] [A10]
  12. ServiceProvider's WaitingListService informs IM User of Contact's JID. [A8]
  13. IM User completes IM User Removes Contact from WaitingList use case.
  14. Use Case Ends.
  1. The URI scheme is not supported:
    1. WaitingListService sends &badrequest; error to IM User and does not add contact to WaitingList.
    2. Use Case Ends unsuccessfully.
  2. The information provided is not a valid URI:
    1. WaitingListService sends ¬acceptable; error to IM User and does not add contact to WaitingList.
    2. Use Case Ends unsuccessfully.
  3. URI belongs to person served by ServiceProvider:
    1. WaitingListService determines that Contact is an IM User registered with ServiceProvider [A7].
    2. WaitingListService informs IM User of Contact's JID. [A9]
    3. IM User completes IM User Removes Contact from WaitingList use case.
    4. Use Case Ends.
  4. URI does not belong to a person served by InteropPartner:
    1. InteropPartner sends ¬found; error to WaitingListService.
    2. If all InteropPartners queried return ¬found; error, WaitingListService sends ¬found; error (or local equivalent) to IM User.
    3. IM User completes IM User Removes Contact from WaitingList use case.
    4. Use Case Ends unsuccessfully.
  5. Contact is not an IM User registered with InteropPartner:
    1. InteropPartner records and acknowledges WaitingListService's request for JID associated with URI.
    2. OPTIONALLY, InteropPartner invites Contact to register as an IM User.
    3. Contact registers.
    4. InteropPartner informs Service Provider's WaitingListService of JID associated with Contact's URI.
    5. ServiceProvider's WaitingListService informs all IM Users who requested JID associated with Contact's URI.
    6. IM User completes IM User Removes Contact from WaitingList use case.
    7. Use Case Ends.
  6. InteropPartner refuses to provide service to ServiceProvider:
    1. InteropPartner's WaitingListService sends ¬authorized; error to ServiceProvider's WaitingListService.
    2. If all other InteropPartners also return errors, WaitingListService returns ¬found; error to IM User.
    3. Use Case Ends unsuccessfully.
  7. Contact is not an IM User registered with ServiceProvider:
    1. WaitingListService records IM User's request for JID associated with URI.
    2. OPTIONALLY, WaitingListService invites Contact to register as an IM User.
    3. Contact registers.
    4. WaitingListService informs all IM Users who requested JID associated with Contact's URI.
    5. IM User completes IM User Removes Contact from WaitingList use case.
    6. Use Case Ends.
  8. Contact's URI is not handled by any ServiceProvider:
    1. WaitingListService informs all IM Users who requested JID associated with Contact's URI that no InteropPartner services Contact's URI.
    2. IM User completes IM User Removes Contact from WaitingList use case.
    3. Use Case Ends unsuccessfully.
  9. IM User completes IM User Removes Contact from WaitingList use case.
    1. ServiceProvider's WaitingListService removes item from WaitingList.
    2. Use Case Ends unsuccessfully.
  10. All Users Remove Contact from Their WaitingLists
    1. ServiceProvider's WaitingListService removes item from WaitingList at InteropPartner's WaitingListService.
    2. Use Case Ends unsuccessfully.

An IM User should remove a contact from the WaitingList after the IM User Adds Contact to WaitingList use case ends (either successfully or unsuccessfully), and may remove a contact from the WaitingList at any other time.

  1. IM User sends removal request to WaitingListService.
  2. WaitingListService removes IM User's request for JID associated with URI.
  3. WaitingListService informs IM User of successful removal [A1].
  4. WaitingListService sends removal request to appropriate InteropPartner's WaitingListService [A2].
  5. InteropPartner's WaitingListService determines that URI belongs to a person served by that partner.
  6. InteropPartner's WaitingListService removes ServiceProvider's WaitingListService's request for JID.
  7. InteropPartner's WaitingListService informs ServiceProvider's WaitingListService of successful removal.
  8. Use Case Ends.
  1. IM User never requested JID associated with URI:
    1. WaitingListService sends ¬found; error to IM User.
    2. Use Case Ends.
  2. Contact URI is served by WaitingListService or IM User was not the only person who requested the JID:
    1. Use Case Ends.

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.

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.

]]> ... Waiting List Service waitinglist ... ]]> ]]> ... ... ]]> ]]>

The WaitingListService SHOULD return detailed information about the service it provides, including the URI schemes it supports (see also the Service Discovery Features section of this document).

]]>

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:

]]>

Upon request, the WaitingListService MUST return the current WaitingList to the IM User:

3033083282 PSA editor@xmpp.org XMPP Extensions Editor ]]>

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.

The WaitingList MAY contain an item for which a JID has been discovered.

3033083282 PSA editor@xmpp.org XMPP Extensions Editor ]]>

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.)

contact-number contact-name ]]>

As described below, various error conditions may occur. (For information about error syntax, refer to RFC 6120 and &xep0086;.)

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.

shakespeare.lit,2005-08:waitlist1 contact-name ]]>

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 Security Considerations section of this document.)

contact-number contact-name ]]>

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.

+1234563033083283 contact-name ]]>

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.

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.

]]>

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: Even if WaitingListService returns Contact JID in the IQ-result, it MUST also send a "JID push" message.

contact-number contact-name ]]>

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.

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 IM User Removes Contact from WaitingList use case).

+1234563033083283 contact-name ]]>

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.

If InterPartner's WaitingListService knows the Contact JID, it sends it to ServiceProvider's WaitingListService as shown in the ServiceProvider's WaitingListService Adds Contact to WaitingList section of this document.

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: 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.

This message contains a WaitingList item. contact-number contact-name ]]>

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.

If WaitingListService learns that Contact's URI is not handled by any InteropPartner, it MUST inform IM User through a "JID push" message:

Sorry, we cannot find this contact. contact-number contact-name ]]>

After receiving the "JID push" message, IM User SHOULD complete the IM User Removes Contact from WaitingList use case.

In order to remove the item from the WaitingList, the IM User MUST complete the Remove Contact from WaitingList use case.

]]>

If WaitingListService previously recorded request, WaitingListService removes request from list and returns result to IM User.

]]>

If WaitingListService did not previously record this request, WaitingListService MUST return an ¬found; error to the IM User.

]]>

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.

A ServiceProvider's WaitingListService MUST be configured with a list of permitted InteropPartner's WaitingListServices with which it communicates. Therefore service discovery SHOULD NOT be necessary. However, if necessary it MAY use either the Agent Information protocol or the Service Discovery protocol as described in the following examples.

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.

]]> ... Waiting List Service waitinglist ... ]]> ]]> ... ... ]]> ]]> ]]>

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.

contact-number ]]>

If InteropPartner refuses to provide service to ServiceProvider, it MUST return a ¬authorized; error to the ServiceProvider:

contact-number ]]>

If Contact's URI is not associated with a person served by this InteropPartner, the InteropPartner MUST return an ¬found; error to the ServiceProvider.

contact-number ]]>

If ServiceProvider's WaitingListService receives ¬authorized; and/or ¬found; errors from all InteropPartners, it returns a ¬found; error to IM User:

+1234563033083283 contact-name ]]>

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.

]]>

If Contact is an IM User served by InteropPartner, InteropPartner's WaitingListService pushes Contact's JID to ServiceProvider's WaitingListService.

contact-number ]]> ]]>

After receiving acknowledgement (but not before), InteropPartner's WaitingListService MUST remove that item from the WaitingList for the ServiceProvider's WaitingListService.

 ]]>

If item exists on WaitingList, InteropPartner's WaitingListService removes item from list and returns result to ServiceProvider's WaitingListService.

]]>

If item does not exist on WaitingList, InteropPartner's WaitingListService MUST return an ¬found; error to the ServiceProvider's WaitingListService.

]]>

  1. Protocols and mechanisms for inviting a Contact to register as an IM User are out of scope for this document and shall be determined by each InteropPartner individually.

  2. A ServiceProvider's WaitingListService MUST record which of its IM Users have requested the JID associated with Contact's URI, and an InteropPartner's WaitingListService MUST record that Service Provider's WaitingListService (not User) has requested JID associated with Contact's URI. Therefore when Contact registers, InteropPartner's WaitingListService informs its local users as well as ServiceProvider's WaitingListService, and ServiceProvider's WaitingListService informs its local users.

  3. 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.

  4. Once an IM User learns a Contact's JID, the IM User MAY send a normal subscription request to the Contact, setting the "to" address to Contact's JID. This interaction is defined in the base XMPP specifications and is out of scope for this document.

  5. For historical reasons, implementations MUST support the older Agent Information protocol (XEP-0094) and SHOULD support Service Discovery (XEP-0030). Note well that the Agent Information protocol will eventually be deprecated in favor of Service Discovery.

  6. An IM User's client receives WaitingList information either through a "JID push" message (received from WaitingListService at any time) or in the IQ result received after requesting the WaitingList (since one or more of the WaitingList items may contain a JID). (The same rule applies to a ServiceProvider's WaitingListService that receives an IQ set from an InteropPartner's WaitingListService.)

  7. When an IM User logs in, the user's client SHOULD request the current WaitingList.

  8. Although the examples in this document show the hostname of the WaitingListService as 'waitlist.third-party.com' (etc.), this is for convenience only; the hostname MAY be any valid DNS hostname.

  9. When sending JID pushes, an implementation MAY specify a message type of 'headline', which in some deployments will prevent such messages from being stored offline for later delivery.

  10. It can happen that WaitingListService does not receive a reply from InteropPartner within a certain amount of time or the connection to InteropPartner times out. Because such behavior is often transient, WaitingListService MAY attempt to reconnect and then resend the request (although any retry logic to handle these cases is a matter of implementation). However, WaitingListService SHOULD NOT return an ¬found; error to IM User unless it knows definitively that the Contact's InteropPartner is permanently unavailable, since returning an ¬found; error in response to temporary connection timeouts is likely to be misleading.

A ServiceProvider's WaitingListService MUST be configured with a list of permitted InteropPartners with which it communicates. The WaitingListService SHOULD NOT communicate with any InteropPartners that are not on the list.

Requesting JIDs via WaitingLists is not bidirectional; i.e., a service MUST NOT allow an IM User to discover a Contact's non-XMPP URI based on the Contact's JID.

A service MAY require a Contact to approve the disclosure of the Contact's JID, either as a global preference or for each request; however, this is a local policy matter.

This document requires no interaction with &IANA;.

The ®ISTRAR; includes 'http://jabber.org/protocol/waitinglist' in its registry of protocol namespaces.

The Jabber Registar includes a type of "waitinglist" in the "directory" category in its registry of service discovery identities.

The XMPP Registrar includes supported URI schemes in its registry of service discovery features. These features shall be of the form 'http://jabber.org/protocol/waitlist/schemes/SCHEME-NAME'.

This document registers the following two namespace names for URI schemes, but others MAY be registered in the future using standard registration procedures:

  • http://jabber.org/protocol/waitlist/schemes/mailto
  • http://jabber.org/protocol/waitlist/schemes/tel
 The protocol documented by this schema is defined in XEP-0130: http://www.xmpp.org/extensions/xep-0130.html Note: there are two allowable root elements for the 'http://jabber.org/protocol/waitinglist' namespace, query and waitlist. The query element is used within IQ stanzas and the waitlist element is used within message stanzas. See XEP-0130 for details. ]]>