SIPPING J. Rosenberg Internet-Draft Cisco Systems Expires: September 19, 2005 H. Schulzrinne Columbia University O. Levin, Ed. Microsoft Corporation March 18, 2005 A Session Initiation Protocol (SIP) Event Package for Conference State draft-ietf-sipping-conference-package-10 Status of this Memo This document is an Internet-Draft and is subject to all provisions of Section 3 of RFC 3667. By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she become aware will be disclosed, in accordance with RFC 3668. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire on September 19, 2005. Copyright Notice Copyright (C) The Internet Society (2005). Abstract This document defines a conference event package for the Session Initiation Protocol (SIP) Events framework, along with a data format Rosenberg, et al. Expires September 19, 2005 [Page 1] Internet-Draft Conference Package March 2005 used in notifications for this package. The conference package allows users to subscribe to a conference URI. Notifications are sent about changes in the membership of this conference and optionally about changes in the state of additional conference components. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . 5 3. Conference Event Package . . . . . . . . . . . . . . . . . . 5 3.1 Event Package Name . . . . . . . . . . . . . . . . . . . . 5 3.2 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . 6 3.3 Subscription Duration . . . . . . . . . . . . . . . . . . 6 3.4 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . 6 3.5 Notifier Processing of SUBSCRIBE Requests . . . . . . . . 7 3.6 Notifier Generation of NOTIFY Requests . . . . . . . . . . 7 3.7 Subscriber Processing of NOTIFY Requests . . . . . . . . . 7 3.8 Handling of Forked Requests . . . . . . . . . . . . . . . 8 3.9 Rate of Notifications . . . . . . . . . . . . . . . . . . 8 3.10 State Agents . . . . . . . . . . . . . . . . . . . . . . 8 4. Conference Document . . . . . . . . . . . . . . . . . . . . 8 4.1 Format . . . . . . . . . . . . . . . . . . . . . . . . . . 8 4.2 Namespace . . . . . . . . . . . . . . . . . . . . . . . . 8 4.3 Versioning . . . . . . . . . . . . . . . . . . . . . . . . 8 4.4 Partial Notifications Mechanism Using 'state' Attribute . 9 4.5 Element Keys . . . . . . . . . . . . . . . . . . . . . . . 10 4.6 Constructing Coherent State Procedure . . . . . . . . . . 10 5. Conference Data . . . . . . . . . . . . . . . . . . . . . . 11 5.1 conference-type . . . . . . . . . . . . . . . . . . . . . 11 5.1.1 conference-description of conference-description-type . . . . . . . . . . . . . 12 5.1.2 host-info of host-type . . . . . . . . . . . . . . . . 12 5.1.3 conference-state of conference-state-type . . . . . . 12 5.1.4 users of users-type . . . . . . . . . . . . . . . . . 12 5.1.5 sidebars-by-ref of uris-type . . . . . . . . . . . . . 13 5.1.6 sidebar-by-val of conference-type . . . . . . . . . . 13 5.2 conference-description-type . . . . . . . . . . . . . . . 13 5.2.1 display-text of string type . . . . . . . . . . . . . 13 5.2.2 subject of string type . . . . . . . . . . . . . . . . 13 5.2.3 free-text of string type . . . . . . . . . . . . . . . 13 5.2.4 keywords of keywords-type . . . . . . . . . . . . . . 13 5.2.5 conf-uris of uris-type . . . . . . . . . . . . . . . . 13 5.2.6 service-uris of uris-type . . . . . . . . . . . . . . 14 5.2.7 maximum-user-count of user-count-type . . . . . . . . 14 5.2.8 available-media of conference-media-type . . . . . . . 14 5.3 host-type . . . . . . . . . . . . . . . . . . . . . . . . 15 5.3.1 display-text of string type . . . . . . . . . . . . . 15 Rosenberg, et al. Expires September 19, 2005 [Page 2] Internet-Draft Conference Package March 2005 5.3.2 web-page of anyURI type . . . . . . . . . . . . . . . 15 5.3.3 uris of uris-type . . . . . . . . . . . . . . . . . . 15 5.4 conference-state-type . . . . . . . . . . . . . . . . . . 15 5.4.1 user-count of user-count-type . . . . . . . . . . . . 15 5.4.2 active of Boolean type . . . . . . . . . . . . . . . . 15 5.4.3 locked of Boolean type . . . . . . . . . . . . . . . . 15 5.5 conference-media-type . . . . . . . . . . . . . . . . . . 16 5.5.1 conference-medium-type . . . . . . . . . . . . . . . . 16 5.5.1.1 display-text of string type . . . . . . . . . . . 16 5.5.1.2 type of string type . . . . . . . . . . . . . . . 16 5.5.1.3 status of media-status-type . . . . . . . . . . . 16 5.6 user-type . . . . . . . . . . . . . . . . . . . . . . . . 16 5.6.1 display-text of string type . . . . . . . . . . . . . 17 5.6.2 associated-aors of anyURI type . . . . . . . . . . . . 17 5.6.3 roles of user-roles-type . . . . . . . . . . . . . . . 17 5.6.4 language of language type . . . . . . . . . . . . . . 17 5.6.5 cascaded-focus of anyURI type . . . . . . . . . . . . 17 5.6.6 endpoint of endpoint-type . . . . . . . . . . . . . . 18 5.7 endpoint-type . . . . . . . . . . . . . . . . . . . . . . 18 5.7.1 display-text of string type . . . . . . . . . . . . . 18 5.7.2 referred of execution-type . . . . . . . . . . . . . . 19 5.7.3 status of endpoint-status-type . . . . . . . . . . . . 19 5.7.4 joining-method of joining-type . . . . . . . . . . . . 20 5.7.5 joining-info of execution-type . . . . . . . . . . . . 20 5.7.6 disconnection-method of disconnection-type . . . . . . 21 5.7.7 disconnection-info of execution-type . . . . . . . . . 21 5.7.8 media of media-type . . . . . . . . . . . . . . . . . 21 5.7.9 call-info of call-type . . . . . . . . . . . . . . . . 22 5.7.10 media-type . . . . . . . . . . . . . . . . . . . . . 22 5.7.10.1 display-text of string type . . . . . . . . . . 22 5.7.10.2 type of string type . . . . . . . . . . . . . . 22 5.7.10.3 label of string type . . . . . . . . . . . . . . 22 5.7.10.4 src-id of string type . . . . . . . . . . . . . 23 5.7.10.5 status of media-status-type . . . . . . . . . . 23 6. XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . 23 7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 31 7.1 Basic Example . . . . . . . . . . . . . . . . . . . . . . 31 7.2 Rich Example . . . . . . . . . . . . . . . . . . . . . . . 33 8. Security Considerations . . . . . . . . . . . . . . . . . . 37 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . 37 9.1 conference Event Package Registration . . . . . . . . . . 37 9.2 application/conference-info+xml MIME Registration . . . . 38 9.3 URN Sub-Namespace Registration for urn:ietf:params:xml:ns:conference-info . . . . . . . . . . 38 9.4 XML Schema Registration . . . . . . . . . . . . . . . . . 39 9.5 URI Purposes Sub-registry Establishment . . . . . . . . . 39 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 40 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 40 Rosenberg, et al. Expires September 19, 2005 [Page 3] Internet-Draft Conference Package March 2005 11.1 Normative References . . . . . . . . . . . . . . . . . . 40 11.2 Informative References . . . . . . . . . . . . . . . . . 41 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 42 Intellectual Property and Copyright Statements . . . . . . . 44 Rosenberg, et al. Expires September 19, 2005 [Page 4] Internet-Draft Conference Package March 2005 1. Introduction The Session Initiation Protocol (SIP) [7]Events Framework [8] defines general mechanisms for subscribing to, and receiving notifications of, events within SIP networks. It introduces the notion of a package, which is a specific "instantiation" of the events framework for a well-defined set of events. Here, we define an event package for SIP conferences. This package provides the conference notification service as outlined in the SIP conferencing framework [18]. As described there, subscriptions to a conference URI are routed to the focus that is handling the conference. It acts as the notifier, and provides clients with updates on conference state. The information provided by this package is comprised of conference identifier(s), conference participants (optionally with their statuses and media description), conference sidebars, conference service URIs, etc. 2. Terminology In this document, the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in RFC 2119 [1] and indicate requirement levels for compliant implementations. 3. Conference Event Package The conference event package allows a user to subscribe to a conference. In SIP, conferences are represented by URIs. These URIs route to a SIP user agent, called a focus, that is responsible for ensuring that all users in the conference can communicate with each other, as described in Conferencing Framework [18]. The focus has sufficient information about the state of the conference to inform subscribers about it. It is possible that a participant in the conference may in fact be another focus. In order to provide a more complete participant list, the focus MAY subscribe to the conference package of the other focus to discover the participant list in the cascaded conference. This information can then be included in notifications by use of the element as specified by this package. This section provides the details for defining a SIP-specific event notification package, as specified by RFC 3265 [8]. 3.1 Event Package Name The name of this event package is "conference". This package name is Rosenberg, et al. Expires September 19, 2005 [Page 5] Internet-Draft Conference Package March 2005 carried in the Event and Allow-Events header, as defined in RFC 3265 [8]. 3.2 SUBSCRIBE Bodies A SUBSCRIBE for a conference package MAY contain a body. This body defines a filter to apply to the subscription. Filter documents are not specified in this document, and at the time of writing, are expected to be the subject of future standardization activity. A SUBSCRIBE for a conference package MAY be sent without a body. This implies the default subscription filtering policy. The default policy is: o Notifications are generated every time there is any change in the state of the conference. o Notifications do not normally contain full state; rather, they only indicate the state that has changed. The exception is a NOTIFY sent in response to a SUBSCRIBE. These NOTIFYs contain the full state of the information requested by the subscriber. 3.3 Subscription Duration The default expiration time for a subscription to a conference is one hour. Once the conference ends, all subscriptions to that particular conference are terminated, with a reason of "noresource" as defined in RFC 3265 [8]. 3.4 NOTIFY Bodies As described in RFC 3265 [8], the NOTIFY message will contain bodies that describe the state of the subscribed resource. This body is in a format listed in the Accept header field of the SUBSCRIBE, or a package-specific default if the Accept header field was omitted from the SUBSCRIBE. In this event package, the body of the notification contains a conference information document. This document describes the state of a conference. All subscribers and notifiers MUST support the "application/conference-info+xml" data format described in Section 5. The subscribe request MAY contain an Accept header field. If no such header field is present, it has a default value of "application/conference-info+xml". If the header field is present, it MUST include "application/conference-info+xml", and MAY include any other types. Of course, the notifications generated by the server MUST be in one of the formats specified in the Accept header field in the SUBSCRIBE request. Rosenberg, et al. Expires September 19, 2005 [Page 6] Internet-Draft Conference Package March 2005 3.5 Notifier Processing of SUBSCRIBE Requests The conference information contains very sensitive information. Therefore, all subscriptions SHOULD be authenticated and then authorized before approval. Authorization policy is at the discretion of the administrator, as always. However, a few recommendations can be made. It is RECOMMENDED that all users in the conference be allowed to subscribe to the conference event package. 3.6 Notifier Generation of NOTIFY Requests Notifications SHOULD be generated for the conference state when a new participant joins (i.e. gets "connected" to) or a participant leaves (i.e. gets "disconnected" from) the conference. Subject to a local focus policy, additional changes in participants' status, changes in their media types, and other optional information MAY be reported by the focus. Changes in sidebar rosters SHOULD be reported by the focus to their participants and MAY be reported to others, subject to local policy. Changes in conference identifiers and service URIs SHOULD be reported by the focus to the Conference package subscribers. Changes in other conference state information MAY be reported by the focus to the Conference package subscribers. 3.7 Subscriber Processing of NOTIFY Requests The SIP Events framework expects packages to specify how a subscriber processes NOTIFY requests in any package specific ways, and in particular, how it uses the NOTIFY requests to construct a coherent view of the state of the subscribed resource. Typically, the NOTIFY for the conference package will only contain information about those users whose state in the conference has changed. To construct a coherent view of the total state of all users, a subscriber to the conference package will need to combine NOTIFYs received over time. Notifications within this package can convey partial information; that is, they can indicate information about a subset of the state associated with the subscription. This means that an explicit algorithm needs to be defined in order to construct coherent and consistent state. The details of this mechanism are specific to the Rosenberg, et al. Expires September 19, 2005 [Page 7] Internet-Draft Conference Package March 2005 particular document type. See Section 4.6 for information on constructing coherent information from an application/conference-info+xml document. 3.8 Handling of Forked Requests By their nature, the conferences supported by this package are centralized. Therefore, SUBSCRIBE requests for a conference should not generally fork. Users of this package MUST NOT install more than a single subscription as a result of a single SUBSCRIBE request. 3.9 Rate of Notifications For reasons of congestion control, it is important that the rate of notifications not become excessive. As a result, it is RECOMMENDED that the server doesn't generate notifications for a single subscriber at a rate faster than once every 5 seconds. 3.10 State Agents Conference state is ideally maintained in the element in which the conference resides. Therefore, the elements that maintain the conference are the ones best suited to handle subscriptions to it. Therefore, the usage of state agents is NOT RECOMMENDED for this package. 4. Conference Document 4.1 Format Conference information is an XML document that MUST be well-formed and valid. It MUST be based on Extensible Markup Language (XML) 1.0 and MUST be encoded using UTF-8 [13]. 4.2 Namespace This specification makes use of XML namespaces for identifying conference information documents and document fragments. The namespace URI for elements defined by this specification is a URN [2], using the namespace identifier 'ietf' defined by [5] and extended by RFC 3688 [14]. This URN is: urn:ietf:params:xml:ns:conference-info 4.3 Versioning The conference information is described by a hierarchal XML structure with the root element . The root element is the Rosenberg, et al. Expires September 19, 2005 [Page 8] Internet-Draft Conference Package March 2005 only element in the schema that carries meaningful version number for all the elements in the document. The whole conference information is associated with this version number. The 'version' attribute MUST be included in the root element. 4.4 Partial Notifications Mechanism Using 'state' Attribute This specification defines a basic partial notifications mechanism that MUST be supported by all subscribing clients. Additional general partial notifications mechanisms can be defined and applied to this package in the future. All sub-elements in the hierarchal XML structure can be classified in two groups: permissible to partial notifications or not. Elements that carry a substantial amount of data that is subject to frequent changes are permissible to partial notifications and have a 'state' attribute attached to them. All future extensions to this schema MUST define which extension elements can also use this mechanism. All other elements can be updated as atomic pieces of data only. Below is the complete list of elements permissible to use the partial notifications mechanism defined in this specification. (Note that future partial notifications mechanisms can potentially be applicable to additional elements.) o Element o Element o Element o Element o Element o Element The 'state' attribute indicates whether the reported information about the element is "full", "partial" or the element is "deleted" from the conference state document. The default value of any 'state' attribute is "full". A 'state' attribute of a child element in the document MUST adhere to its parent 'state'. It means that if the parent's 'state' is "full", the state of its children MUST be "full". If the parent's 'state' is "partial", the state of its children MAY be either "partial", "full", or "deleted". Rosenberg, et al. Expires September 19, 2005 [Page 9] Internet-Draft Conference Package March 2005 4.5 Element Keys The defined XML schema has a property of unique identification among sub-elements of a common parent, which is permissible to use the partial notifications mechanism defined in this document. This property is achieved by defining a key to each sub-element with possible multiple appearances under the common parent. In the context of this specification, the element key is the set of mandatory attributes or sub-elements of an element. The key value MUST be unique for the element among its siblings of the same type. Below is the list of elements (subject to partial notifications of their parent elements) with their keys as defined by this specification: o Element uses as the key 'entity' o Element uses as the key 'entity' o Element uses as the key 'id' o Element (child to ) uses as the key 'entity' o Element uses as the key 4.6 Constructing Coherent State Procedure A conference package subscriber locally maintains a local version number, a local element for each element in the schema, and a table for each element with key(s) in the schema. For first time a NOTIFY with a "full" document is received (as indicated by the value of the 'state' attribute in the element), the conference package subscriber MUST set the local 'version' number to the value of the 'version' attribute from the received and populate local data with the received information. Each time a new NOTIFY is received, the value of the local version number and the value of the 'version' attribute in the new received document are compared. If the value in the document is equal or less than the local version, the document is discarded without processing. Otherwise, if the received NOTIFY contains a "full" or "deleted" state, the conference package subscriber MUST set the local 'version' number to the value of the 'version' attribute from the received and replace the local information with the received document. Receiving "deleted" state means that the conference ceased to exist and the subscriber SHOULD terminate the subscription by sending the SUBSCRIBE with Expires = 0. Rosenberg, et al. Expires September 19, 2005 [Page 10] Internet-Draft Conference Package March 2005 Otherwise (i.e. if the received NOTIFY contains "partial" state), if the 'version' number in the received document is more than one number higher than the previous local version number, the subscriber MUST generate a refresh request to trigger a full state notification. If the 'version' number in the document is one higher than the local version number, the local version number is updated accordingly and the document is used to update the local content as described below. For each sub-element of the element in the received document, 1. If the element contains "full" state, the whole local element content is flushed and repopulated from the document. 2. Otherwise, if the element contains "deleted" state, the whole element MUST be removed from the local content. 3. Otherwise, if the element contains "partial" state: 3.1 For elements with keys, the subscriber compares the keys received in the update with the keys in the local tables. 3.1.1 If a key does not exist in the local table, a row is added, and its content is set to the element information from the update. 3.1.2 Otherwise, if a key of the same value does exist, for each sub-element in the row the algorithm is applied from step 3.2. 3.2 For each atomic element received in the schema, the element is replaced with the new information as a whole. Also, for each non-atomic element received in the schema with either no 'state' attribute included or the state attribute is set to "full", the element is replaced with the new information as a whole. 3.3 For each non-atomic element with the state attribute set to "partial", the algorithm is applied recursively starting from step 3.1. 5. Conference Data A conference information document begins with the root element tag of conference-type. Sections below describe the complex types composing the hierarchal conference-type. The full XML schema is defined in Section 6. 5.1 conference-type This type defines the following attributes: Rosenberg, et al. Expires September 19, 2005 [Page 11] Internet-Draft Conference Package March 2005 entity: This attribute contains the conference URI that identifies the conference being described in the document. state: This attribute indicates whether the document contains the whole conference information ("full"), only the information that has changed since the previous document ("partial"), or the conference ceased to exist ("deleted"). For more details see Section 4. version: This attribute allows the recipient of conference information documents to properly order them and it MUST be included when used in the root element. Version number is a 32 bit monotonically increasing integer scoped within a subscription. A server MUST increment the version number by one for each new partial notification being sent to a subscriber. The conference-type defines an extendable sequence of child elements. A "full" conference document MUST at least include the following sub-elements: , , and . The child elements are described in details below: 5.1.1 conference-description of conference-description-type This element contains conference information that is derived from system conference policies, is set before the conference activation, and is rarely changed during the conference lifetime. 5.1.2 host-info of host-type This element contains information about the entity that hosts the conference. This information is set before the conference activation, and is rarely changed during the conference lifetime, unless the whole conference is moved to be hosted by another entity. 5.1.3 conference-state of conference-state-type This element contains the dynamic information about the current state of the conference. 5.1.4 users of users-type This element can contain an unbounded number of sub-elements of user-type each containing the information about a participant in the conference. Rosenberg, et al. Expires September 19, 2005 [Page 12] Internet-Draft Conference Package March 2005 5.1.5 sidebars-by-ref of uris-type This element contains sub-elements of uri-type which provide pointers to sidebar information through sidebar URIs. The recipient of the information can then subscribe to sidebar information independently from the main conference package subscription. 5.1.6 sidebar-by-val of conference-type This element provides sidebar information as a part of the main conference package information. 5.2 conference-description-type This type defines an extendable sequence of the following child elements: 5.2.1 display-text of string type This element contains text description of the conference. 5.2.2 subject of string type This element contains the subject of the conference. 5.2.3 free-text of string type This element contains free form text about the conference. 5.2.4 keywords of keywords-type This element contains a list of words that can be used by automatic search engines to better classify the conference. 5.2.5 conf-uris of uris-type This element contains a set of sub-elements - each containing the information about an additional conference URI that this conference can be accessed by. The value of the URI is included in the sub-element and its description MAY be included in the sub-element. The purpose of the URI SHOULD be included in the sub-element. The currently defined values to be used with the are: Rosenberg, et al. Expires September 19, 2005 [Page 13] Internet-Draft Conference Package March 2005 participation: Indicates that dialing into this URI will bring the party into the conference streaming: Indicates that "listening" to this URI will provide the conference live content Future extensions to this schema may define new values and register them with IANA under the registry established by this specification. Examples of such URIs include sip: / sips: [7], h323: [17], and tel: [16] URIs. 5.2.6 service-uris of uris-type This element contains a set of sub-elements - each containing the URI to be used in order to access different services available for the particular conference. The value of the URI is included in the sub-element and its description MAY be included in the sub-element. The purpose of the URI SHOULD be included in the sub-element. The currently defined values to be used with the are: web-page: Indicates the web page containing the additional information about the conference recording: Indicates the link at which the recorded conference context can be retrieved event: Indicates the URI to which the subscription to the conference event package needs to be performed Future extensions to this schema may define new values and register them with IANA under the registry established by this specification. 5.2.7 maximum-user-count of user-count-type This element, if used, specifies the maximum number of users permitted in the conference and SHOULD include the counter for all participants in the conference in total by populating the attribute 'role' with value "any". Counters for users with specific roles MAY be additionally provided. 5.2.8 available-media of conference-media-type This element contains information about the media streams with their types available to the participants in the conference. The entries in the container are of conference-medium-type and are indexed by attribute 'label'. Rosenberg, et al. Expires September 19, 2005 [Page 14] Internet-Draft Conference Package March 2005 5.3 host-type This type defines an extendable sequence of the following child elements: 5.3.1 display-text of string type This element contains display text information about the entity hosting the conference. 5.3.2 web-page of anyURI type This element contains a web page URI about the user hosting the conference. 5.3.3 uris of uris-type The sub-element contains additional URIs pointing to the conference host. 5.4 conference-state-type This type defines an extendable sequence of the following child elements. 5.4.1 user-count of user-count-type This element is used to specify the current number of users in the conference. The number SHOULD be provided for all participants in total by populating the sub-element with value "any". Additionally counters for users with certain roles in the conference MAY be separately provided. 5.4.2 active of Boolean type This element says whether the conference is currently active or not. A conference is active if dialing into one of the results in successful establishment of a call signaling session between the dialed user and the conference focus. 5.4.3 locked of Boolean type This element contains information about whether the conference is currently locked. In this context, "locked" means that the conference roster can not be added to (although participants may leave or be removed from the conference). Rosenberg, et al. Expires September 19, 2005 [Page 15] Internet-Draft Conference Package March 2005 5.5 conference-media-type This type defines a sequence of child elements, each of conference-medium-type. This type defines an extendable sequence of the following child elements. 5.5.1 conference-medium-type This type defines the 'label' attribute, which is the media stream identifier being assigned by the conferencing server. This value is unique in the conference context. The value of this attribute MAY correspond to the SDP "label" media attribute defined in [21]. This type defines an extendable sequence of the following child elements. 5.5.1.1 display-text of string type This element contains the display text for the media stream. 5.5.1.2 type of string type This element contains the media type of the media stream. The value of this element MUST be one of the values registered for "media" of SDP [3] and its later revision(s). 5.5.1.3 status of media-status-type The element indicates the status in both directions of the media stream and has the values "sendrecv", "sendonly", "recvonly", or "inactive" as defined in SDP [3] and its later revision(s). Note that value specifies the direction from the participant's point of view. 5.6 user-type This type defines the following attributes: entity: This attribute contains the URI for the user in the conference. This is a logical identifier, which corresponds to the authenticated identity of the participant. The 'entity' attribute MUST be unique in the user element list because it is used as the key in partial notifications about users' state. An anonymous participant in a conference SHOULD be represented by an anonymous URI generated by the focus. For multiple anonymous participants, the focus must ensure that each anonymous URI is Rosenberg, et al. Expires September 19, 2005 [Page 16] Internet-Draft Conference Package March 2005 unique. The guidelines for generating anonymous URIs in RFC 3323 [9] should be followed. For example, "Anonymous1" could be used for a participant requesting privacy. state: This attribute indicates whether the document contains the whole conference information ("full"), only the information that has changed since the previous document ("partial"), or the conference ceased to exist ("deleted"). This type defines an extendable sequence of the following child elements. 5.6.1 display-text of string type This element contains the display text for the user. 5.6.2 associated-aors of anyURI type This element contains associated URIs of the user. Usually this information will be manually provided by a system administrator showing the logical association between signaling entities otherwise independent. 5.6.3 roles of user-roles-type This element contains the roles of the user. 5.6.4 language of language type This element contains the language preference of the user. This information can be automatically learned via call signaling or be manually set per participant. 5.6.5 cascaded-focus of anyURI type This element contains a conference URI (different from the main conference URI) for users that are connected to the main conference as a result of focus cascading. In accordance with the SIP conferencing framework [18], this package allows for representation of peer-to-peer (i.e. "flat") focus cascading only. The actual cascading graph can not be deduced from the information provided in the package alone. Advanced applications can construct the graph by subscribing to both this package and the Dialog Package [19] of each cascaded focus and correlating the relevant information. Rosenberg, et al. Expires September 19, 2005 [Page 17] Internet-Draft Conference Package March 2005 5.6.6 endpoint of endpoint-type This element contains information about an endpoint or/and a session of the parent . The element can have unbounded number of appearances for each user participating in the conference. The mandatory 'entity' key of an identifies either one of the user devices or one of the call signaling sessions of this user with the focus. In a conferencing system where authentication is performed per endpoint (rather than per user), a focus is not necessarily aware of the logical association of multiple endpoints under a common user. In this case, the focus would arrange the endpoints as belonging to separate users in the conference document. Note, that typically in this case, a would contain a single with corresponding 'entity' attributes having the same value, unless multiple call signaling sessions are taking place between the endpoint and the focus simultaneously. In a different case, due to privacy concerns for a participant, a focus may choose to shield the information about the participant's multiple endpoints from the third-party subscribers. To do so, the focus MAY aggregate the multiple endpoints' information into a single element under the participant's . 5.7 endpoint-type This type defines the following attributes: entity: The value of this attribute MUST be a unique in the context of the . In SIP terms, this can be the Contact URI, GRUU, etc. state: This attribute indicates whether the element contains the whole endpoint information ("full"), only the information that has changed since the previous document ("partial"), or the endpoint has been deleted from the conference ("deleted"). This type defines an extendable sequence of the following child elements. 5.7.1 display-text of string type This element contains the display text for the endpoint. Rosenberg, et al. Expires September 19, 2005 [Page 18] Internet-Draft Conference Package March 2005 5.7.2 referred of execution-type This element contains information about the user who's action resulted in this endpoint being brought into the conference (e.g. the SIP user identified by this URI sent a REFER to the focus). It can contain the following sub-elements: when: This element contains the date and time that the endpoint was referred to the conference and SHOULD be expressed in Coordinated Universal Time (UTC) format. reason: This element contains the reason the endpoint was referred to the conference. by: This element contains the URI of the entity who caused the endpoint to be referred to the conference. 5.7.3 status of endpoint-status-type This element contains the status of the endpoint, and can assume the following values: connected: The endpoint is a participant in the conference. Depending on the media policies, he/she can send and receive media to and from other participants. disconnected: The endpoint is not a participant in the conference and no active dialog exists between the endpoint and the focus. on-hold: Active SIP dialog exists between an endpoint and a focus, but endpoint is "on-hold" for this conference, i.e. neither he/she is "hearing" the conference mix, nor is his/her media being mixed in the conference. As an example, the endpoint has asked to join the conference using SIP, but his/her participation is pending based on moderator approval. In the meantime he/she is hearing music-on-hold or some other kind of related content. muted-via-focus: Active SIP dialog exists between an endpoint and a focus and the endpoint can "listen" to the conference, but endpoint's media is not being mixed into the conference. Note that sometimes a subset of endpoint media streams can be muted by focus (such as poor quality video) while others (such as voice or IM) can still be active. In this case, it is RECOMMENDED that the "aggregated" endpoint connectivity reflects the status of the most active media. Rosenberg, et al. Expires September 19, 2005 [Page 19] Internet-Draft Conference Package March 2005 pending: Endpoint is not yet in the session, but it is anticipated that he/she will join in the near future. alerting: A PSTN ALERTING or SIP 180 Ringing was returned for the outbound call, endpoint is being alerted. dialing-in: Endpoint is dialing into the conference, not yet in the roster (probably being authenticated). dialing-out: Focus has dialed out to connect the endpoint to the conference, but the endpoint is not yet in the roster (probably being authenticated). disconnecting: Focus is in the process of disconnecting endpoint (either DISCONNECT or BYE was sent to the endpoint). Note that the defined transient statuses (e.g., disconnecting, alerting, etc.) could generate a lot of notifications. Implementations MAY choose not to generate notifications on these to all participants if it will generate too much traffic. 5.7.4 joining-method of joining-type This element contains method by which the endpoint joined the conference, and can assume the following values: dialed-in: The endpoint dialed into the conference, i.e. sent INVITE to the focus, which resulted in successful dialog establishment. dialed-out: The focus has brought the endpoint into the conference by sending a successful INVITE to the endpoint. focus-owner: The endpoint is the focus for this conference. This status is used only when a participant's UA acts as a conference focus. 5.7.5 joining-info of execution-type This element contains information about how the endpoint joined and can contain the following sub-elements: when: This element contains the date and time that the endpoint joined the conference and SHOULD be expressed in Coordinated Universal Time (UTC). Rosenberg, et al. Expires September 19, 2005 [Page 20] Internet-Draft Conference Package March 2005 reason: This element contains the reason the endpoint joined the conference. by: This element contains the URI of the entity who caused the endpoint to join the conference. 5.7.6 disconnection-method of disconnection-type This element contains method by which the endpoint departed the conference, and can assume the following values: departed: The endpoint sent a BYE, thus leaving the conference. booted: The endpoint was sent a BYE by the focus, booting him/her out of the conference. Alternatively, the endpoint tried to dial into to conference but was rejected by the focus due to local policy. failed: The server tried to bring the endpoint into the conference, but its attempt to contact the specific endpoint resulted in a non-200 class final response. Alternatively, the endpoint tried to dial into the conference without success due to technical reasons. 5.7.7 disconnection-info of execution-type This element contains information about the endpoint's departure from the conference and can contain the following sub-elements: when: This element contains the date and time that the endpoint departed the conference and SHOULD be expressed in Coordinated Universal Time (UTC). reason: This element contains the reason the endpoint departed the conference. When known and meaningful, it is RECOMMENDED to include the information as conveyed/reported by the call signaling in the format defined by RFC 3326 [10]. For example, Reason: SIP ;cause=415 ;text="Unsupported Media Type" by: This element contains the URI of the entity who caused the endpoint to depart the conference. 5.7.8 media of media-type This element contains information about a media stream of the endpoint. The element of the media-type can have an unbounded number Rosenberg, et al. Expires September 19, 2005 [Page 21] Internet-Draft Conference Package March 2005 of appearances in the endpoint-type for each media stream of the endpoint. Note, that if the sub-element of the endpoint is not included by the server, it is possible that the media streams listed under the common endpoint were established by separate signaling sessions (i.e. belong to different "calls" or "dialogs"). 5.7.9 call-info of call-type The element MAY be used for providing detailed call signaling information for a call being maintained between the endpoint and the focus. Note, that privacy policies MUST be consulted before revealing this information to third-party participants. The sub-element contains the SIP dialog identifier of the endpoint's dialog with the focus. The element includes sub-elements , , , . In future, the element can be expanded to include call signaling protocol information for other protocols besides SIP. 5.7.10 media-type This type defines the following attribute: id: The attribute is the media stream identifier being generated by the notification server such as its value is unique in the endpoint context. This attribute is the key to refer to a particular media stream in the conference document. This type defines an extendable sequence of the following child elements. 5.7.10.1 display-text of string type This element contains the display text for the media stream. 5.7.10.2 type of string type This element contains the media type for the media stream. The value of this element MUST be one of the values registered for "media" of SDP [3] and its later revision(s). 5.7.10.3 label of string type The element