draft-ietf-sipping-conference-package-06.txt   draft-ietf-sipping-conference-package-07.txt 
SIPPING J. Rosenberg SIPPING J. Rosenberg
Internet-Draft dynamicsoft Internet-Draft Cisco Systems
Expires: April 25, 2005 H. Schulzrinne Expires: May 28, 2005 H. Schulzrinne
Columbia University Columbia University
O. Levin, Ed. O. Levin, Ed.
Microsoft Corporation Microsoft Corporation
October 25, 2004 November 27, 2004
A Session Initiation Protocol (SIP) Event Package for Conference A Session Initiation Protocol (SIP) Event Package for Conference
State State
draft-ietf-sipping-conference-package-06 draft-ietf-sipping-conference-package-07
Status of this Memo Status of this Memo
This document is an Internet-Draft and is subject to all provisions This document is an Internet-Draft and is subject to all provisions
of section 3 of RFC 3667. By submitting this Internet-Draft, each of section 3 of RFC 3667. By submitting this Internet-Draft, each
author represents that any applicable patent or other IPR claims of 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 is aware have been or will be disclosed, and any of
which he or she become aware will be disclosed, in accordance with which he or she become aware will be disclosed, in accordance with
RFC 3668. RFC 3668.
skipping to change at page 1, line 39 skipping to change at page 1, line 40
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt. http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
This Internet-Draft will expire on April 25, 2005. This Internet-Draft will expire on May 28, 2005.
Copyright Notice Copyright Notice
Copyright (C) The Internet Society (2004). Copyright (C) The Internet Society (2004).
Abstract Abstract
This document defines a conference event package for the Session This document defines a conference event package for the Session
Initiation Protocol (SIP) Events framework, along with a data format Initiation Protocol (SIP) Events framework, along with a data format
used in notifications for this package. The conference package used in notifications for this package. The conference package
allows users to subscribe to a conference URI. Notifications are allows users to subscribe to a conference URI. Notifications are
sent about changes in the membership of this conference and sent about changes in the membership of this conference and
optionally about changes in the state of additional conference optionally about changes in the state of additional conference
components. components.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 5 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 6 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 5
3. Conference Event Package . . . . . . . . . . . . . . . . . . . 7 3. Conference Event Package . . . . . . . . . . . . . . . . . . . 6
3.1 Event Package Name . . . . . . . . . . . . . . . . . . . . 7 3.1 Event Package Name . . . . . . . . . . . . . . . . . . . . 6
3.2 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . 7 3.2 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . 6
3.3 Subscription Duration . . . . . . . . . . . . . . . . . . 7 3.3 Subscription Duration . . . . . . . . . . . . . . . . . . 6
3.4 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . 8 3.4 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . 7
3.5 Notifier Processing of SUBSCRIBE Requests . . . . . . . . 8 3.5 Notifier Processing of SUBSCRIBE Requests . . . . . . . . 7
3.6 Notifier Generation of NOTIFY Requests . . . . . . . . . . 8 3.6 Notifier Generation of NOTIFY Requests . . . . . . . . . . 7
3.7 Subscriber Processing of NOTIFY Requests . . . . . . . . . 9 3.7 Subscriber Processing of NOTIFY Requests . . . . . . . . . 8
3.8 Handling of Forked Requests . . . . . . . . . . . . . . . 9 3.8 Handling of Forked Requests . . . . . . . . . . . . . . . 8
3.9 Rate of Notifications . . . . . . . . . . . . . . . . . . 9 3.9 Rate of Notifications . . . . . . . . . . . . . . . . . . 8
3.10 State Agents . . . . . . . . . . . . . . . . . . . . . . . 9 3.10 State Agents . . . . . . . . . . . . . . . . . . . . . . . 8
4. Conference Data Model . . . . . . . . . . . . . . . . . . . . 11 4. Conference Document . . . . . . . . . . . . . . . . . . . . . 10
5. Constructing Coherent State . . . . . . . . . . . . . . . . . 12 4.1 Format . . . . . . . . . . . . . . . . . . . . . . . . . . 10
6. Conference Data . . . . . . . . . . . . . . . . . . . . . . . 14 4.2 Namespace . . . . . . . . . . . . . . . . . . . . . . . . 10
6.1 Conference Information . . . . . . . . . . . . . . . . . . 14 4.3 Versioning . . . . . . . . . . . . . . . . . . . . . . . . 10
6.1.1 Conference Type . . . . . . . . . . . . . . . . . . . 14 4.4 State and Partial Notifications . . . . . . . . . . . . . 10
6.1.1.1 conference-description of 4.5 Element Keys . . . . . . . . . . . . . . . . . . . . . . . 11
conference-description-type . . . . . . . . . . . 14 4.6 Constructing Coherent State Procedure . . . . . . . . . . 11
6.1.1.2 host-info of host-type . . . . . . . . . . . . . . 14 5. Conference Data . . . . . . . . . . . . . . . . . . . . . . . 13
6.1.1.3 conference-state of conference-state-type . . . . 15 5.1 conference-type . . . . . . . . . . . . . . . . . . . . . 13
6.1.1.4 user of user-type . . . . . . . . . . . . . . . . 15 5.1.1 conference-description of
6.1.1.5 sidebars-by-ref of uris-type . . . . . . . . . . . 15 conference-description-type . . . . . . . . . . . . . 13
6.1.1.6 sidebar-by-val of conference-type . . . . . . . . 15 5.1.2 host-info of host-type . . . . . . . . . . . . . . . . 13
6.1.2 Conference Description Type . . . . . . . . . . . . . 15 5.1.3 conference-state of conference-state-type . . . . . . 14
6.1.2.1 display-text of string type . . . . . . . . . . . 15 5.1.4 users of users-type . . . . . . . . . . . . . . . . . 14
6.1.2.2 subject of string type . . . . . . . . . . . . . . 15 5.1.5 sidebars-by-ref of uris-type . . . . . . . . . . . . . 14
6.1.2.3 free-text of string type . . . . . . . . . . . . . 15 5.1.6 sidebar-by-val of conference-type . . . . . . . . . . 14
6.1.2.4 keywords of keywords-type . . . . . . . . . . . . 16 5.2 conference-description-type . . . . . . . . . . . . . . . 14
6.1.2.5 web-page of anyURI type . . . . . . . . . . . . . 16 5.2.1 display-text of string type . . . . . . . . . . . . . 14
6.1.2.6 conf-uris of uris-type . . . . . . . . . . . . . . 16 5.2.2 subject of string type . . . . . . . . . . . . . . . . 14
6.1.2.7 service-uris of uris-type . . . . . . . . . . . . 16 5.2.3 free-text of string type . . . . . . . . . . . . . . . 14
6.1.2.8 maximum-user-count of user-count-type . . . . . . 16 5.2.4 keywords of keywords-type . . . . . . . . . . . . . . 14
6.1.2.9 available-media of conference-medias-type . . . . 16 5.2.5 conf-uris of uris-type . . . . . . . . . . . . . . . . 15
6.1.3 Host Type . . . . . . . . . . . . . . . . . . . . . . 16 5.2.6 service-uris of uris-type . . . . . . . . . . . . . . 15
6.1.3.1 display-text of string type . . . . . . . . . . . 16 5.2.7 maximum-user-count of user-count-type . . . . . . . . 15
6.1.3.2 web-page of anyURI type . . . . . . . . . . . . . 17 5.2.8 available-media of conference-medias-type . . . . . . 15
6.1.3.3 uris of uris-type . . . . . . . . . . . . . . . . 17 5.3 host-type . . . . . . . . . . . . . . . . . . . . . . . . 15
6.1.4 Conference State Type . . . . . . . . . . . . . . . . 17 5.3.1 display-text of string type . . . . . . . . . . . . . 15
6.1.4.1 user-count of user-count-type . . . . . . . . . . 17 5.3.2 web-page of anyURI type . . . . . . . . . . . . . . . 16
6.1.4.2 security-level of security-level-type . . . . . . 17 5.3.3 uris of uris-type . . . . . . . . . . . . . . . . . . 16
6.1.4.3 active of Boolean type . . . . . . . . . . . . . . 17 5.4 conference-state-type . . . . . . . . . . . . . . . . . . 16
6.1.4.4 locked of Boolean type . . . . . . . . . . . . . . 17 5.4.1 user-count of user-count-type . . . . . . . . . . . . 16
6.1.4.5 recording of uris-type . . . . . . . . . . . . . . 17 5.4.2 active of Boolean type . . . . . . . . . . . . . . . . 16
6.1.4.6 active-media of conference-medias-type . . . . . . 18 5.4.3 locked of Boolean type . . . . . . . . . . . . . . . . 16
6.1.5 User Type . . . . . . . . . . . . . . . . . . . . . . 18 5.4.4 recording of uris-type . . . . . . . . . . . . . . . . 16
6.1.5.1 display-text of string type . . . . . . . . . . . 18 5.4.5 active-media of conference-medias-type . . . . . . . . 17
6.1.5.2 associated-aors of anyURI type . . . . . . . . . . 18 5.5 user-type . . . . . . . . . . . . . . . . . . . . . . . . 17
6.1.5.3 roles of user-roles-type . . . . . . . . . . . . . 18 5.5.1 display-text of string type . . . . . . . . . . . . . 17
6.1.5.4 language of language type . . . . . . . . . . . . 19 5.5.2 associated-aors of anyURI type . . . . . . . . . . . . 17
6.1.5.5 cascaded-focus of anyURI type . . . . . . . . . . 19 5.5.3 roles of user-roles-type . . . . . . . . . . . . . . . 17
6.1.5.6 endpoint of endpoint-type . . . . . . . . . . . . 19 5.5.4 language of language type . . . . . . . . . . . . . . 18
6.1.6 Endpoint Type . . . . . . . . . . . . . . . . . . . . 19 5.5.5 cascaded-focus of anyURI type . . . . . . . . . . . . 18
6.1.6.1 display-text of string type . . . . . . . . . . . 20 5.5.6 endpoint of endpoint-type . . . . . . . . . . . . . . 18
6.1.6.2 referred of execution-type . . . . . . . . . . . . 20 5.6 endpoint-type . . . . . . . . . . . . . . . . . . . . . . 18
6.1.6.3 state of endpoint-state-type . . . . . . . . . . . 20 5.6.1 display-text of string type . . . . . . . . . . . . . 19
6.1.6.4 joining-method of joining-type . . . . . . . . . . 21 5.6.2 referred of execution-type . . . . . . . . . . . . . . 19
6.1.6.5 joining-info of execution-type . . . . . . . . . . 21 5.6.3 status of endpoint-status-type . . . . . . . . . . . . 19
6.1.6.6 disconnection-method of disconnection-type . . . . 22 5.6.4 joining-method of joining-type . . . . . . . . . . . . 20
6.1.6.7 disconnection-info of disconnection-type . . . . . 22 5.6.5 joining-info of execution-type . . . . . . . . . . . . 21
6.1.6.8 whispering-to of uris-type . . . . . . . . . . . . 22 5.6.6 disconnection-method of disconnection-type . . . . . . 21
6.1.6.9 media of media-type . . . . . . . . . . . . . . . 22 5.6.7 disconnection-info of execution-type . . . . . . . . . 21
6.1.7 Media Type . . . . . . . . . . . . . . . . . . . . . . 23 5.6.8 media of media-type . . . . . . . . . . . . . . . . . 22
6.1.7.1 display-text of string type . . . . . . . . . . . 23 5.7 media-type . . . . . . . . . . . . . . . . . . . . . . . . 22
6.1.7.2 proto of string type . . . . . . . . . . . . . . . 23 5.7.1 display-text of string type . . . . . . . . . . . . . 22
6.1.7.3 ssrc of string type . . . . . . . . . . . . . . . 23 5.7.2 proto of string type . . . . . . . . . . . . . . . . . 22
6.1.7.4 label of string type . . . . . . . . . . . . . . . 24 5.7.3 src-id of string type . . . . . . . . . . . . . . . . 22
6.1.7.5 state of media-state-type . . . . . . . . . . . . 24 5.7.4 label of string type . . . . . . . . . . . . . . . . . 23
6.1.7.6 snd-status of media-state-type . . . . . . . . . . 24 5.7.5 status of media-status-type . . . . . . . . . . . . . 23
6.1.7.7 rcv-status state of media-state-type . . . . . . . 24 5.7.6 call of call-type . . . . . . . . . . . . . . . . . . 23
6.1.7.8 call of call-type . . . . . . . . . . . . . . . . 24 6. XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . 24
7. Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
8. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 7.1 Basic Example . . . . . . . . . . . . . . . . . . . . . . 32
8.1 Basic Example . . . . . . . . . . . . . . . . . . . . . . 33 7.2 Rich Example . . . . . . . . . . . . . . . . . . . . . . . 34
8.2 Rich Example . . . . . . . . . . . . . . . . . . . . . . . 35 8. Security Considerations . . . . . . . . . . . . . . . . . . . 39
9. Security Considerations . . . . . . . . . . . . . . . . . . . 40 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 40
10. IANA Considerations . . . . . . . . . . . . . . . . . . . . 41 9.1 conference Event Package Registration . . . . . . . . . . 40
10.1 conference Event Package Registration . . . . . . . . . . 41 9.2 application/conference-info+xml MIME Registration . . . . 40
10.2 application/conference-info+xml MIME Registration . . . . 41 9.3 URN Sub-Namespace Registration for
10.3 URN Sub-Namespace Registration for urn:ietf:params:xml:ns:conference-info . . . . . . . . . . 40
urn:ietf:params:xml:ns:conference-info . . . . . . . . . . 41 9.4 XML Schema Registration . . . . . . . . . . . . . . . . . 41
10.4 XML Schema Registration . . . . . . . . . . . . . . . . . 42 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 42
11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 43 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 43
12. Changes History . . . . . . . . . . . . . . . . . . . . . . 44 11.1 Normative References . . . . . . . . . . . . . . . . . . . . 43
12.1 Changes since -05 . . . . . . . . . . . . . . . . . . . . 44 11.2 Informative References . . . . . . . . . . . . . . . . . . . 43
12.2 Changes since -04 . . . . . . . . . . . . . . . . . . . . 44 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 44
12.3 Changes since -03 . . . . . . . . . . . . . . . . . . . . 44 Intellectual Property and Copyright Statements . . . . . . . . 46
12.4 Changes since -02 . . . . . . . . . . . . . . . . . . . . 44
12.5 Changes since -01 . . . . . . . . . . . . . . . . . . . . 45
13. References . . . . . . . . . . . . . . . . . . . . . . . . . 46
13.1 Normative References . . . . . . . . . . . . . . . . . . . . 46
13.2 Informative References . . . . . . . . . . . . . . . . . . . 46
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 47
Intellectual Property and Copyright Statements . . . . . . . . 49
1. Introduction 1. Introduction
The Session Initiation Protocol (SIP) [6] Events framework Events The Session Initiation Protocol (SIP) [6] Events framework Events
Framework [7] defines general mechanisms for subscribing to, and Framework [7] defines general mechanisms for subscribing to, and
receiving notifications of, events within SIP networks. It receiving notifications of, events within SIP networks. It
introduces the notion of a package, which is a specific introduces the notion of a package, which is a specific
"instantiation" of the events framework for a well-defined set of "instantiation" of the events framework for a well-defined set of
events. Here, we define an event package for SIP conferences. This events. Here, we define an event package for SIP conferences. This
package provides the conference notification service as outlined in package provides the conference notification service as outlined in
the SIP conferencing framework [15]. As described there, the SIP conferencing framework [16]. As described there,
subscriptions to a conference URI are routed to the focus that is subscriptions to a conference URI are routed to the focus that is
handling the conference. It acts as the notifier, and provides handling the conference. It acts as the notifier, and provides
clients with updates on conference state. clients with updates on conference state.
The information provided by this package is comprised of conference The information provided by this package is comprised of conference
identifier(s), conference participants (optionally with their identifier(s), conference participants (optionally with their
statuses and media description), conference sidebars, conference statuses and media description), conference sidebars, conference
service URIs, etc. service URIs, etc.
2. Terminology 2. Terminology
In this document, the key words "MUST", "MUST NOT", "REQUIRED", In this document, the key words "MUST", "MUST NOT", "REQUIRED",
"SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
and "OPTIONAL" are to be interpreted as described in RFC 2119 [2] and and "OPTIONAL" are to be interpreted as described in RFC 2119 [1] and
indicate requirement levels for compliant implementations. indicate requirement levels for compliant implementations.
3. Conference Event Package 3. Conference Event Package
The conference event package allows a user to subscribe to a The conference event package allows a user to subscribe to a
conference. In SIP, conferences are represented by URIs. These URIs conference. In SIP, conferences are represented by URIs. These URIs
route to a SIP user agent, called a focus, that is responsible for route to a SIP user agent, called a focus, that is responsible for
ensuring that all users in the conference can communicate with each ensuring that all users in the conference can communicate with each
other, as described in Conferencing Framework [15]. The focus has other, as described in Conferencing Framework [16]. The focus has
sufficient information about the state of the conference to inform sufficient information about the state of the conference to inform
subscribers about it. subscribers about it.
It is possible a participant in the conference may in fact be another It is possible a participant in the conference may in fact be another
focus. In order to provide a more complete participant list, the focus. In order to provide a more complete participant list, the
focus MAY subscribe to the conference package of the other focus to focus MAY subscribe to the conference package of the other focus to
discover the participant list in the cascaded conference. This discover the participant list in the cascaded conference. This
information can then be included in notifications by using of the information can then be included in notifications by using of the
"cascaded-focus" element as specified by this package. <cascaded-focus> element as specified by this package.
This section provides the details for defining a SIP Events package, This section provides the details for defining a SIP Events package,
as specified by RFC 3265 [7]. as specified by RFC 3265 [7].
3.1 Event Package Name 3.1 Event Package Name
The name of this event package is "conference". This package name is The name of this event package is "conference". This package name is
carried in the Event and Allow-Events header, as defined in RFC 3265 carried in the Event and Allow-Events header, as defined in RFC 3265
[7]. [7].
skipping to change at page 8, line 17 skipping to change at page 7, line 17
As described in RFC 3265 [7], the NOTIFY message will contain bodies As described in RFC 3265 [7], the NOTIFY message will contain bodies
that describe the state of the subscribed resource. This body is in 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 a format listed in the Accept header field of the SUBSCRIBE, or a
package-specific default if the Accept header field was omitted from package-specific default if the Accept header field was omitted from
the SUBSCRIBE. the SUBSCRIBE.
In this event package, the body of the notification contains a In this event package, the body of the notification contains a
conference information document. This document describes the state conference information document. This document describes the state
of a conference. All subscribers and notifiers MUST support the of a conference. All subscribers and notifiers MUST support the
"application/conference-info+xml" data format described in Section 6. "application/conference-info+xml" data format described in Section 5.
The subscribe request MAY contain an Accept header field. If no such The subscribe request MAY contain an Accept header field. If no such
header field is present, it has a default value of header field is present, it has a default value of
"application/conference-info+xml". If the header field is present, "application/conference-info+xml". If the header field is present,
it MUST include "application/conference-info+xml", and MAY include it MUST include "application/conference-info+xml", and MAY include
any other types. any other types.
Of course, the notifications generated by the server MUST be in one Of course, the notifications generated by the server MUST be in one
of the formats specified in the Accept header field in the SUBSCRIBE of the formats specified in the Accept header field in the SUBSCRIBE
request. request.
skipping to change at page 9, line 29 skipping to change at page 8, line 29
information about those users whose state in the conference has information about those users whose state in the conference has
changed. To construct a coherent view of the total state of all changed. To construct a coherent view of the total state of all
users, a subscriber to the conference package will need to combine users, a subscriber to the conference package will need to combine
NOTIFYs received over time. NOTIFYs received over time.
Notifications within this package can convey partial information; Notifications within this package can convey partial information;
that is, they can indicate information about a subset of the state that is, they can indicate information about a subset of the state
associated with the subscription. This means that an explicit associated with the subscription. This means that an explicit
algorithm needs to be defined in order to construct coherent and algorithm needs to be defined in order to construct coherent and
consistent state. The details of this mechanism are specific to the consistent state. The details of this mechanism are specific to the
particular document type. See Section 5 for information on particular document type. See Section 4.6 for information on
constructing coherent information from an constructing coherent information from an
application/conference-info+xml document. application/conference-info+xml document.
3.8 Handling of Forked Requests 3.8 Handling of Forked Requests
By their nature, the conferences supported by this package are By their nature, the conferences supported by this package are
centralized. Therefore, SUBSCRIBE requests for a conference should centralized. Therefore, SUBSCRIBE requests for a conference should
not generally fork. Users of this package MUST NOT install more than not generally fork. Users of this package MUST NOT install more than
a single subscription as a result of a single SUBSCRIBE request. a single subscription as a result of a single SUBSCRIBE request.
skipping to change at page 11, line 5 skipping to change at page 10, line 5
a rate faster than once every 5 seconds. a rate faster than once every 5 seconds.
3.10 State Agents 3.10 State Agents
Conference state is ideally maintained in the element in which the Conference state is ideally maintained in the element in which the
conference resides. Therefore, the elements that maintain the conference resides. Therefore, the elements that maintain the
conference are the ones best suited to handle subscriptions to it. conference are the ones best suited to handle subscriptions to it.
Therefore, the usage of state agents is NOT RECOMMENDED for this Therefore, the usage of state agents is NOT RECOMMENDED for this
package. package.
4. Conference Data Model 4. Conference Document
4.1 Format
Conference information is an XML document that MUST be well-formed Conference information is an XML document that MUST be well-formed
and SHOULD be valid. Dialog information documents MUST be based on and SHOULD be valid. It MUST be based on Extensible Markup Language
XML 1.0 and MUST be encoded using UTF-8. This specification makes (XML) 1.0 and MUST be encoded using UTF-8 [11].
use of XML namespaces for identifying dialog information documents
and document fragments. The namespace URI for elements defined by 4.2 Namespace
this specification is a URN [3], using the namespace identifier
'ietf' defined by [4] and extended by [1]. This URN is: 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 [4] and
extended by RFC 3688 [12]. This URN is:
urn:ietf:params:xml:ns:conference-info
4.3 Versioning
The conference information is described by a hierarchal XML structure The conference information is described by a hierarchal XML structure
with the root element "conference-info". The root element is the with the root element <conference-info>. The root element is the
only element in the schema that carries meaningful version number for only element in the schema that carries meaningful version number for
all the elements in the document. The whole conference information all the elements in the document. The whole conference information
is associated with this version number. is associated with this version number.
All sub-elements in the "conference-info" hierarchal XML structure The optional 'version' attribute MUST be included in the root
<conference-info> element.
4.4 State and Partial Notifications
All sub-elements in the <conference-info> hierarchal XML structure
can be classified in two groups: those that carry relatively small can be classified in two groups: those that carry relatively small
amount of data and those that can potentially carry a lot of data. amount of data and those that can potentially carry a lot of data.
During partial notifications, the light elements are updated as During partial notifications, the light elements are updated as
atomic pieces of data. On the other hand, elements that can carry a atomic pieces of data. On the other hand, elements that can carry a
substantial amount of data have the general "state" attribute substantial amount of data have the general 'state' attribute
attached to them. That is in order to support partial notifications attached to them. That is in order to support partial notifications
for their content. for their content.
A "state" attribute of a child element in the document MUST adhere to The 'state' attribute indicates whether the reported information
its parent "state". It means that if the parent's "state" is "full", about the element is "full", "partial" or the element is "deleted"
the state of its children MUST be "full". If the parent's "state" is 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", "partial", the state of its children MAY be either "partial", "full",
or "deleted". or "deleted".
For elements with the optional "state" attribute, if the attribute is 4.5 Element Keys
omitted from the notification for the element, it means that the
reported element's state is "full".
All sub-elements, with possible multiple appearances under a common In the context of this specification, the element key is the set of
parent, have keys defined to them in order to uniquely identify each mandatory attributes or sub-elements of the element. The key value
element among others of the same type in the partial notification MUST be unique for the element among its siblings of the same type.
event.
5. Constructing Coherent State In a partial notification event it must be possible to uniquely
identify each sub-element among others of the same type under a
common parent element. In order to achieve this property, all
sub-elements, with possible multiple appearances under a common
parent (which has the attribute 'state') have keys defined to them.
A Conference package subscriber MUST initialize the "version" Below is the list of the elements with their keys as defined by this
attribute from the "conference-info" element with the value in the specification:
o Elements <conference-info>, <user>, and <endpoint> use as the key
'entity'
o Element <media> uses as the key 'id'
o Sub-element <entry> of uris-type contained in elements
<conf-uris>, <service-uris>, and <recording> uses as the key
<uri>
o Elements <available-media> and <active-media> of
conference-medias-type use as the key <proto>
o Elements <maximum-user-count> and <user-count> of count-type use
as the key <role>
o Element <role> of user-roles-type uses as the key <entry>
o Sub-element <entry> of conference-type contained in element
<sidebars-by-val> uses as the key 'entity'
o Elements <associated-uris> and <sidebars-by-ref> of uris-type use
as the key <uri>
4.6 Constructing Coherent State Procedure
A Conference package subscriber MUST initialize the 'version'
attribute from the <conference-info> element with the value in the
first document received. first document received.
The conference package subscriber locally maintains a local element The conference package subscriber locally maintains a local element
for each element in the schema and a table for each element with for each element in the schema and a table for each element with
key(s) in the schema and indexed by these key(s). key(s) in the schema and indexed by these key(s).
Each time a new NOTIFY is received, the value of the local version Each time a new NOTIFY is received, the value of the local version
number and the "version" attribute in the new received document are number and the value of the 'version' attribute in the new received
compared. If the value in the new document is one higher than the document are compared. If the value in the document is less than the
local version number, the local version number is increased by one, local version, the document is discarded without processing. If the
and the document is processed. If the value in the document is more value in the document is higher than the local version number, the
than one higher than the local version number, the local version local version number is set to the value in the new document and the
number is set to the value in the new document, the document is document is processed. If the value in the received document is more
processed, and the subscriber SHOULD generate a refresh request to than one higher than the previous local version number and the
trigger a full state notification. If the value in the document is document contained a partial state, the subscriber SHOULD generate a
less than the local version, the document is discarded without refresh request to trigger a full state notification.
processing.
Further processing of the conference information document depends on Further processing of the conference information depends on the state
whether it contains full or partial state. If it contains full contained in the received conference document and indicated by the
state, indicated by the value of the "state" attribute in the value of the 'state' attribute in the <conference-info> element. If
"conference-info" element, the whole local content is flushed and it contains "full" state, the whole local content is flushed and
repopulated from the document. If it contains "deleted" state, repopulated from the document. If it contains "deleted" state, it
indicated by the value of the "state" attribute in the means that the conference ceased to exist and the subscriber SHOULD
"conference-info" element, it means that the conference ceased to terminate the subscription by sending the SUBSCRIBE with Expires = 0.
exist and the subscriber SHOULD terminate the SUBSCRIBE dialog.
If the document contains partial state, as indicated by the value of If the document contains "partial" state, the document is used to
the "state" attribute in the "conference-info" element, the document update the local content as described below.
is used to update the local content as described below.
Starting from outer elements in the received document, Starting from outer elements in the received document,
1. If the parent element contains "full" state, the whole local 1. If the parent element contains "full" state, the whole local
element content is flushed and repopulated from the document. element content is flushed and repopulated from the document.
2. Otherwise, if the parent element contains "deleted" state, the 2. Otherwise, if the parent element contains "deleted" state, the
whole element MUST be removed from the local content. whole element MUST be removed from the local content.
3. Otherwise, if the parent element contains "partial" state: 3. Otherwise, if the parent element contains "partial" state:
skipping to change at page 13, line 13 skipping to change at page 12, line 43
in the update with the keys in the local tables. 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 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. 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 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 2.2. sub-element in the row the algorithm is applied from step 2.2.
3.2 For each atomic element received in the schema, the element is 3.2 For each atomic element received in the schema, the element is
replaced with the new information as a whole. Also, for each replaced with the new information as a whole. Also, for each
non-atomic element received in the schema with either no "state" non-atomic element received in the schema with either no 'state'
attribute included or the state attribute is set to "full", the attribute included or the state attribute is set to "full", the
element is replaced with the new information as a whole. element is replaced with the new information as a whole.
3.2.1 If an element, which doesnĘt have key(s), is updated or created
such that its content is empty, that element MAY be removed from the
local content at any time.
3.3 For each non-atomic element with the state attribute set to 3.3 For each non-atomic element with the state attribute set to
"partial", the algorithm is applied recursively starting from step 3. "partial", the algorithm is applied recursively starting from step 3.
6. Conference Data 5. Conference Data
urn:ietf:params:xml:ns:conference-info
A conference information document begins with the root element tag A conference information document begins with the root element tag
"conference-info". <conference-info> of conference-type. Sections below describe the
complex types composing the hierarchal conference-type. The full XML
6.1 Conference Information schema is defined in Section 6.
A conference instance is defined as a top level element
"conference-info" of a type "conference-type". Sections below
describe the complex types composing the hierarchal
"conference-type". The full XML schema is defined in Section 7.
6.1.1 Conference Type 5.1 conference-type
This type has the following attributes: This type defines the following attributes:
version: This mandatory attribute allows the recipient of conference entity: This attribute contains the conference URI that identifies
information documents to properly order them. Versions start at 0 the conference being described in the document.
and increment by one for each new document sent to a subscriber.
Versions are scoped within a subscription. Versions MUST be
represented using a 32 bit integer.
entity: This mandatory attribute contains the conference URI that state: This attribute indicates whether the document contains the
identifies the conference being described in the document. 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 <conference-info> element.
Versions start at 0 and increment by one for each new document
sent to a subscriber. Versions are scoped within a subscription.
Versions are represented using a 32 bit integer.
state: This mandatory attribute indicates whether the document The conference-type defines an extendable sequence of child elements.
contains the whole conference information ("full"), only the A "full" conference document MUST at least include the following
information that has changed since the previous document sub-elements: <conference-description>, <conference-state>, and
("partial"), or the conference ceased to exist ("deleted"). For <users>.
more details see Section 5.
This type defines an extendable sequence of the following optional The child elements are described in details below:
child elements:
6.1.1.1 conference-description of conference-description-type 5.1.1 conference-description of conference-description-type
This element contains conference information that is derived from This element contains conference information that is derived from
system conference policies, is set before the conference activation, system conference policies, is set before the conference activation,
and is rarely changed during the conference lifetime. and is rarely changed during the conference lifetime.
6.1.1.2 host-info of host-type 5.1.2 host-info of host-type
This element contains information about the entity that hosts the This element contains information about the entity that hosts the
conference. This information is set before the conference conference. This information is set before the conference
activation, and is rarely changed during the conference lifetime, activation, and is rarely changed during the conference lifetime,
unless the whole conference is moved to be hosted by another entity. unless the whole conference is moved to be hosted by another entity.
6.1.1.3 conference-state of conference-state-type 5.1.3 conference-state of conference-state-type
This element contains the dynamic information about the current state This element contains the dynamic information about the current state
of the focus. of the conference.
6.1.1.4 user of user-type 5.1.4 users of users-type
This element contains the information about a participant in the This element can contain an unbounded number of <user> sub-elements
conference. The element of the user-type can have unbounded number of user-type each containing the information about a participant in
of appearance in the conference-type for each participant in the the conference.
conference.
6.1.1.5 sidebars-by-ref of uris-type 5.1.5 sidebars-by-ref of uris-type
This element provides a pointer to sidebar information through This element contains <entry> sub-elements of uri-type which provide
sidebar URIs. The recipient of the information can then subscribe to pointers to sidebar information through sidebar URIs. The recipient
sidebar information independently from the main Conference package of the information can then subscribe to sidebar information
subscription. independently from the main conference package subscription.
6.1.1.6 sidebar-by-val of conference-type 5.1.6 sidebar-by-val of conference-type
This element provides sidebar information as a part of the main This element provides sidebar information as a part of the main
Conference package information. conference package information.
6.1.2 Conference Description Type 5.2 conference-description-type
This element contains the "state" attribute which can contain the This type defines the 'state' attribute which can contain the values
values "full", "partial", or deleted". "full", "partial", or "deleted".
This type defines an extendable sequence of the following optional This type defines an extendable sequence of the following child
child elements: elements:
6.1.2.1 display-text of string type 5.2.1 display-text of string type
This element contains text information about the conference. This element contains text description of the conference.
6.1.2.2 subject of string type 5.2.2 subject of string type
This element contains information about the subject of a conference. This element contains the subject of the conference.
6.1.2.3 free-text of string type 5.2.3 free-text of string type
This element contains free form text about the conference. This element contains free form text about the conference.
6.1.2.4 keywords of keywords-type 5.2.4 keywords of keywords-type
This element contains a list of keywords which describe the
conference topic.
6.1.2.5 web-page of anyURI type This element contains a list of words that can be used by automatic
search engines to better classify the conference.
This element contains a URI of a web page that contains information 5.2.5 conf-uris of uris-type
related to the conference.
6.1.2.6 conf-uris of uris-type This element contains a set of <entry> 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 <uri> sub-element and its description MAY be included in the
<display-text> sub-element.
This element contains information about additional conference URIs Examples of such URIs include h323: [15] and tel: [14] URIs.
that this conference can be accessed by. Examples of such URIs
include h323: [14] and tel: [13] URIs.
6.1.2.7 service-uris of uris-type 5.2.6 service-uris of uris-type
This element contains the service-related URIs. These URIs can be This element contains a set of <entry> sub-elements - each containing
used to manipulate the conference policies or state, for example. 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 <uri> sub-element and its description MAY be included in the
<display-text> sub-element. The purpose of the URI SHOULD be
included in the <purpose> sub-element. The only currently defined
<purpose> value is "web-page" which indicates a web page that
contains additional information about the conference. Future
extensions to this schema may define new values and establish an IANA
registry for the new values.
6.1.2.8 maximum-user-count of user-count-type 5.2.7 maximum-user-count of user-count-type
This element contains a count of the maximum number of users This element is used to specify the maximum number of users permitted
permitted in the conference. The count can be specified for all in the conference. The number SHOULD be provided for all
participants in total (using the sub-element with value "any") or participants in total by populating the <role> sub-element with value
count the users by their roles in the conference. "any". Additionally counters for users with certain roles in the
conference MAY be separately provided.
6.1.2.9 available-media of conference-medias-type 5.2.8 available-media of conference-medias-type
This element contains information about the media types available in This element contains information about the media types available in
a conference. The "entry" sub-element MUST be a value registered for the conference. The <entry> sub-element MUST contain one of the
"proto" of SDP [12]. values registered for "proto" of SDP [3] and its later revision(s).
6.1.3 Host Type 5.3 host-type
This element contains the "state" attribute which can contain the This type defines the 'state' attribute which can contain the values
values "full", "partial", or deleted". "full", "partial", or "deleted".
This type defines an extendable sequence of the following optional This type defines an extendable sequence of the following child
child elements: elements:
6.1.3.1 display-text of string type 5.3.1 display-text of string type
This element contains display text information about the user hosting This element contains display text information about the entity
the conference. hosting the conference.
6.1.3.2 web-page of anyURI type 5.3.2 web-page of anyURI type
This element contains a web page URI about the user hosting the This element contains a web page URI about the user hosting the
conference. conference.
6.1.3.3 uris of uris-type 5.3.3 uris of uris-type
The "entity" sub-element contains additional URIs relating to the
user hosting the conference.
6.1.4 Conference State Type
This element contains the "state" attribute which can contain the The <entity> sub-element contains additional URIs pointing to the
values "full", "partial", or deleted". conference host.
This type defines an extendable sequence of the following optional 5.4 conference-state-type
child elements.
6.1.4.1 user-count of user-count-type This type defines the 'state' attribute which can contain the values
"full", "partial", or "deleted".
This element contains a count of the current number of users in the This type defines an extendable sequence of the following child
conference. The count can be specified for all participants in total elements.
(using the sub-element with value "any") or count the users by their
roles in the conference.
6.1.4.2 security-level of security-level-type 5.4.1 user-count of user-count-type
This element contains information about the conference security This element is used to specify the current number of users in the
level. The values can be "none", "low", "medium", or "high". conference. The number SHOULD be provided for all participants in
total by populating the <role> sub-element with value "any".
Additionally counters for users with certain roles in the conference
MAY be separately provided.
6.1.4.3 active of Boolean type 5.4.2 active of Boolean type
This element contains information about whether the conference is This element says whether the conference is currently active or not.
currently active or not. For example, a conference can be scheduled for a certain start time
and its conference URI reserved and published. Still, the conference
will not be "active" till its actual start time.
6.1.4.4 locked of Boolean type 5.4.3 locked of Boolean type
This element contains information about whether the conference is This element contains information about whether the conference is
currently locked. In this context, locked means that the conference currently locked. In this context, "locked" means that the
roster can not be added to (although participants may leave or be conference roster can not be added to (although participants may
removed from the conference). leave or be removed from the conference).
6.1.4.5 recording of uris-type 5.4.4 recording of uris-type
The "entry" sub-element contains URIs related to the recording of the The <entry> sub-element contains URIs related to the recording of the
conference. conference.
6.1.4.6 active-media of conference-medias-type 5.4.5 active-media of conference-medias-type
This element contains information about the media types currently This element contains information about the media types currently
active in the conference which is a subset of those listed in the active in the conference, which is a subset of those listed in the
"available-media" element. <available-media> element.
6.1.5 User Type 5.5 user-type
This type has the following attributes: This type defines the following attributes:
entity: The mandatory attribute contains the URI for the user in the entity: This attribute contains the URI for the user in the
conference. This is a logical identifier, which corresponds to conference. This is a logical identifier, which corresponds to
the authenticated identity of the participant. The "entity" the authenticated identity of the participant. The 'entity'
attribute MUST be unique in the user element list because it is attribute MUST be unique in the user element list because it is
used as the key in partial notifications about users' state. An used as the key in partial notifications about users' state. An
anonymous participant in a conference SHOULD be represented by an anonymous participant in a conference SHOULD be represented by an
anonymous URI generated by the focus. For multiple anonymous anonymous URI generated by the focus. For multiple anonymous
participants, the focus must ensure that each anonymous URI is participants, the focus must ensure that each anonymous URI is
unique. The guidelines for generating anonymous URIs in RFC 3323 unique. The guidelines for generating anonymous URIs in RFC 3323
[8] should be followed. For example, [8] should be followed. For example,
"Anonymous1" <sip:anonymous1@anonymous.invalid> "Anonymous1" <sip:anonymous1@anonymous.invalid>
could be used for a participant requesting privacy. could be used for a participant requesting privacy.
state: This mandatory attribute indicates whether the document state: This attribute indicates whether the document contains the
contains the whole conference information ("full"), only the whole conference information ("full"), only the information that
information that has changed since the previous document has changed since the previous document ("partial"), or the
("partial"), or the conference ceased to exist ("deleted"). conference ceased to exist ("deleted").
This type defines an extendable sequence of the following optional This type defines an extendable sequence of the following child
child elements. elements.
6.1.5.1 display-text of string type 5.5.1 display-text of string type
This element contains the display text for the user. This element contains the display text for the user.
6.1.5.2 associated-aors of anyURI type 5.5.2 associated-aors of anyURI type
This element contains associated URIs of the user. Usually this This element contains associated URIs of the user. Usually this
information will be manually provided by a system administrator information will be manually provided by a system administrator
showing the logical association between signaling entities otherwise showing the logical association between signaling entities otherwise
independent. independent.
6.1.5.3 roles of user-roles-type 5.5.3 roles of user-roles-type
This element contains the roles of the user. This element contains the roles of the user.
6.1.5.4 language of language type 5.5.4 language of language type
This element contains the language used by the user. This element contains the language preference of the user. This
information can be automatically learned via call signaling or be
manually set per participant.
6.1.5.5 cascaded-focus of anyURI type 5.5.5 cascaded-focus of anyURI type
This element contains a conference URI (different from the main This element contains a conference URI (different from the main
conference URI) for users that are connected to the main conference conference URI) for users that are connected to the main conference
as a result of focus cascading. In accordance with the SIP as a result of focus cascading. In accordance with the SIP
conferencing framework [15], this package allows for representation conferencing framework [16], this package allows for representation
of peer-to-peer (i.e. "flat") focus cascading only. The actual of peer-to-peer (i.e. "flat") focus cascading only. The actual
cascading graph can not be deduced from the information provided in cascading graph can not be deduced from the information provided in
the package alone. Advanced applications can construct the graph by the package alone. Advanced applications can construct the graph by
subscribing to both this package and the Dialog Package [16] of the subscribing to both this package and the Dialog Package [17] of the
cascaded foci and correlating the relevant information. cascaded foci and correlating the relevant information.
6.1.5.6 endpoint of endpoint-type 5.5.6 endpoint of endpoint-type
This element contains information about an endpoint of the user. The This element contains information about an endpoint of the user. The
element of the endpoint-type can have unbounded number of appearance element of the endpoint-type can have unbounded number of appearance
in the user-type for each endpoint of the user participating in the in the user-type for each endpoint of the user participating in the
conference. In a case when authentication is performed per endpoint conference. In a case when authentication is performed per endpoint
(rather than per user) in a system, a focus can be not aware of the (rather than per user) in a system, a focus can be not aware of the
logical association among endpoints being used by the same user. In logical association among endpoints being used by the same user. In
this case the focus MAY present the endpoints as belonging to this case the focus MAY present the endpoints as belonging to
separate users in the conference schema. separate users in the conference schema.
In a different case, due to privacy concerns for a user the focus may In a different case, due to privacy concerns for a user, the focus
want to shield the information about multiple endpoints from the may want to shield the information about multiple endpoints from the
recipients of the Conference document. To do so the focus MAY recipients of the Conference document. To do so the focus MAY
aggregate the multiple endpoint information into a single endpoint aggregate the multiple endpoint information into a single endpoint
element under this user. element under this user.
6.1.6 Endpoint Type 5.6 endpoint-type
This type has the following attributes: This type defines the following attributes:
entity: The mandatory attribute contains the endpoint URI for the entity: The attribute contains the endpoint URI for the user in the
user in the conference. In SIP terms, this is the Contact URI or conference. In SIP terms, this is the Contact URI or GRUU. The
GRUU. The "entity" attribute MUST be unique in the endpoint 'entity' attribute MUST be unique in the endpoint element list
element list because it is used as the key in partial because it is used as the key in partial notifications about
notifications about users' endpoints. An anonymous participant in users' endpoints. An endpoint belonging to an anonymous
a conference SHOULD be represented by an anonymous URI generated participant in a conference SHOULD be represented by an anonymous
by the focus. For multiple anonymous participants, the focus must URI generated by the focus. For multiple anonymous endpoints, the
ensure that each anonymous URI is unique. The guidelines for focus must ensure that each anonymous URI is unique. The
generating anonymous URIs in RFC 3323 [8] should be followed. guidelines for generating anonymous URIs in RFC 3323 [8] should be
followed.
state: This mandatory attribute indicates whether the element state: This attribute indicates whether the element contains the
contains the whole endpoint information ("full"), only the whole endpoint information ("full"), only the information that has
information that has changed since the previous document changed since the previous document ("partial"), or the endpoint
("partial"), or the endpoint has been deleted from the conference has been deleted from the conference ("deleted").
("deleted").
This type defines an extendable sequence of the following optional This type defines an extendable sequence of the following child
child elements. elements.
6.1.6.1 display-text of string type 5.6.1 display-text of string type
This element contains the display text for the endpoint. This element contains the display text for the endpoint.
6.1.6.2 referred of execution-type 5.6.2 referred of execution-type
This element contains the URI of the user who's action resulted in This element contains information about the user who's action
this endpoint being brought into the conference (e.g. the user resulted in this endpoint being brought into the conference (e.g.
identified by this URI sent a REFER to the focus). the SIP user identified by this URI sent a REFER to the focus). It
can contain the following sub-elements:
6.1.6.3 state of endpoint-state-type when: This element contains the date and time that the endpoint was
referred to the conference.
This element contains the state of the endpoint, and can assume the 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.6.3 status of endpoint-status-type
This element contains the status of the endpoint, and can assume the
following values: following values:
connected: The endpoint is a participant in the conference. connected: The endpoint is a participant in the conference.
Depending on the media policies, he/she can send and receive media Depending on the media policies, he/she can send and receive media
to and from other participants. to and from other participants.
disconnected: The endpoint is not a participant in the conference and disconnected: The endpoint is not a participant in the conference and
no active dialog exists between the endpoint and the focus. no active dialog exists between the endpoint and the focus.
on-hold: Active SIP dialog exists between an endpoint and a focus, on-hold: Active SIP dialog exists between an endpoint and a focus,
skipping to change at page 20, line 50 skipping to change at page 20, line 12
join the conference using SIP, but his/her participation is join the conference using SIP, but his/her participation is
pending based on moderator approval. In the meantime he/she is pending based on moderator approval. In the meantime he/she is
hearing music-on-hold or some other kind of related content. hearing music-on-hold or some other kind of related content.
muted-via-focus: Active SIP dialog exists between an endpoint and a muted-via-focus: Active SIP dialog exists between an endpoint and a
focus and the endpoint can "listen" to the conference, but focus and the endpoint can "listen" to the conference, but
endpoint's media is not being mixed into the conference. Note endpoint's media is not being mixed into the conference. Note
that sometimes a subset of endpoint media streams can be muted by that sometimes a subset of endpoint media streams can be muted by
focus (such as poor quality video) while others (such as voice or 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 IM) can still be active. In this case, it is RECOMMENDED that the
"aggregated" endpoint connectivity "status" reflects the status of "aggregated" endpoint connectivity <status> reflects the status of
the mostly active media. the mostly active media.
pending: Endpoint is not yet in the session, but it is anticipated pending: Endpoint is not yet in the session, but it is anticipated
that he/she will join in the near future. that he/she will join in the near future.
alerting: A PSTN ALERTING or SIP 180 Ringing was returned for the alerting: A PSTN ALERTING or SIP 180 Ringing was returned for the
outbound call, endpoint is being alerted. outbound call, endpoint is being alerted.
dialing-in: Endpoint is dialing into the conference, not yet in the dialing-in: Endpoint is dialing into the conference, not yet in the
roster (probably being authenticated). roster (probably being authenticated).
dialing-out: Focus has dialed out to connect the endpoint to the dialing-out: Focus has dialed out to connect the endpoint to the
conference, but the endpoint is not yet in the roster (probably conference, but the endpoint is not yet in the roster (probably
being authenticated). being authenticated).
disconnecting: Focus is in the process of disconnecting endpoint disconnecting: Focus is in the process of disconnecting endpoint
(either DISCONNECT or BYE was sent to the endpoint's device). (either DISCONNECT or BYE was sent to the endpoint).
Note that the defined transient states (e.g., disconnecting, Note that the defined transient statuss (e.g., disconnecting,
alerting, etc.) could generate a lot of notifications. alerting, etc.) could generate a lot of notifications.
Implementations MAY choose not to generate notifications on these to Implementations MAY choose not to generate notifications on these to
all participants if it will generate too much traffic. all participants if it will generate too much traffic.
6.1.6.4 joining-method of joining-type 5.6.4 joining-method of joining-type
This element contains method by which the endpoint joined the This element contains method by which the endpoint joined the
conference, and can assume the following values: conference, and can assume the following values:
dialed-in: The endpoint dialed into the conference, i.e. sent INVITE dialed-in: The endpoint dialed into the conference, i.e. sent INVITE
to the focus, which resulted in successful dialog establishment. to the focus, which resulted in successful dialog establishment.
dialed-out: The focus has brought the endpoint into the conference by dialed-out: The focus has brought the endpoint into the conference by
sending a successful INVITE to the endpoint. sending a successful INVITE to the endpoint.
focus-owner: The endpoint is the focus for this conference. This focus-owner: The endpoint is the focus for this conference. This
status is used only when a participant UA acts as a conference status is used only when a participantĘs UA acts as a conference
focus. focus.
6.1.6.5 joining-info of execution-type 5.6.5 joining-info of execution-type
This element contains information about how the endpoint joined and This element contains information about how the endpoint joined and
can contain the following sub-elements: can contain the following sub-elements:
when: This element contains the date and time that the endpoint when: This element contains the date and time that the endpoint
joined the conference. joined the conference.
reason: This element contains the reason the endpoint joined the reason: This element contains the reason the endpoint joined the
conference. conference.
by: This element contains the URI of the entity who caused the by: This element contains the URI of the entity who caused the
endpoint to join the conference. endpoint to join the conference.
6.1.6.6 disconnection-method of disconnection-type 5.6.6 disconnection-method of disconnection-type
This element contains method by which the endpoint departed the This element contains method by which the endpoint departed the
conference, and can assume the following values: conference, and can assume the following values:
departed: The endpoint sent a BYE, thus leaving the conference. departed: The endpoint sent a BYE, thus leaving the conference.
booted: The endpoint was sent a BYE by the focus, booting him/her out booted: The endpoint was sent a BYE by the focus, booting him/her out
of the conference. Alternatively, the endpoint tried to dial into of the conference. Alternatively, the endpoint tried to dial into
to conference without success because was rejected by the focus to conference without success because was rejected by the focus
according to local policy decisions. according to local policy decisions.
failed: The server tried to bring the endpoint into the conference, failed: The server tried to bring the endpoint into the conference,
but its attempt to contact the specific endpoint resulted in a but its attempt to contact the specific endpoint resulted in a
non-200 class final response. Alternatively, the endpoint tried non-200 class final response. Alternatively, the endpoint tried
to dial into the conference without success due to technical to dial into the conference without success due to technical
reasons. reasons.
6.1.6.7 disconnection-info of disconnection-type 5.6.7 disconnection-info of execution-type
This element contains information about the endpoint's departure from This element contains information about the endpoint's departure from
the conference and can contain the following sub-elements: the conference and can contain the following sub-elements:
when: This element contains the date and time that the endpoint when: This element contains the date and time that the endpoint
departed the conference. departed the conference.
reason: This element contains the reason the endpoint departed the reason: This element contains the reason the endpoint departed the
conference. conference. When known, it is RECOMMENDED to include the numeric
reason followed by the descriptive text as conveyed/reported by
the call signaling.
by: This element contains the URI of the entity who caused the by: This element contains the URI of the entity who caused the
endpoint to depart the conference. endpoint to depart the conference.
6.1.6.8 whispering-to of uris-type 5.6.8 media of media-type
If an endpoint is participating in a whisper session with other
entities, the URIs of these other entities MAY be contained in this
element.
6.1.6.9 media of media-type
This element contains information about a media stream of this This element contains information about a media stream of this
endpoint. The element of the media-type can have unbounded number of endpoint. The element of the media-type can have unbounded number of
appearance in the endpoint-type for each media stream of the appearance in the endpoint-type for each media stream of the
endpoint. Note that it is possible that media streams listed under a endpoint. Note that it is possible that media streams listed under a
common endpoint MAY be established by separate signaling means and common endpoint MAY be established by separate signaling means and
consequently belong to different signaling "calls". consequently belong to different signaling "calls".
6.1.7 Media Type 5.7 media-type
This type has the following attributes: This type defines the following attributes:
entity: The mandatory attribute is a unique identifier of a media id: The attribute is a unique identifier of a media stream on a per
stream on a per endpoint basis. This attribute is used as a key endpoint basis. This attribute is used as a key to identify media
to identify media streams which may be added and deleted on a streams which may be added and deleted on a dynamic basis during
dynamic basis during the conference. The value of this element the conference. If the SDP "mid" (as defined in Grouping of Media
SHOULD correspond to the "mid" value in the SDP document as Lines in the SDP [9]) is used for establishing the media stream,
defined in Grouping of Media Lines in the SDP [9]. the 'id' SHOULD contain the same "mid" value, otherwise the
notification service MUST generate an 'id' value which is unique
in the endpoint context.
state: This mandatory attribute indicates whether the element state: This attribute indicates whether the element contains the
contains the whole media information ("full"), only the whole media information ("full"), only the information that has
information that has changed since the previous document changed since the previous notification ("partial"), or that the
("partial"), or the media element has been deleted from the media element has been deleted from the conference document
conference document ("deleted"). ("deleted").
This type defines an extendable sequence of the following optional This type defines an extendable sequence of the following child
child elements. elements.
6.1.7.1 display-text of string type 5.7.1 display-text of string type
This element contains the display text for the media stream. This element contains the display text for the media stream.
6.1.7.2 proto of string type 5.7.2 proto of string type
This element contains the media type for the media stream. The value This element contains the media type for the media stream. The value
of this element MUST be a value registered for "proto" of SDP [12]. of this element MUST be one of the values registered for "proto" of
SDP [3] and its later revision(s).
6.1.7.3 ssrc of string type 5.7.3 src-id of string type
The "ssrc" element carries the value of SSRC (defined in RTP/RTCP The <src-id> element, if applicable, carries the information about
[10]) as generated by the endpoint for the stream it sends. When an the actual source of the media. For example, for the RTP/RTCP [10]
RTP mixer generates a CSRC list according to RTP/RTCP [10], it media streams the value MUST contain the SSRC value generated by the
inserts a list of the SSRC identifiers of the sources that endpoint for the stream it sends.
When an RTP mixer generates a CSRC list according to RTP/RTCP [10],
it inserts a list of the SSRC identifiers of the sources that
contributed to the generation of a particular packet into the RTP contributed to the generation of a particular packet into the RTP
header of that packet. "An example application is audio conferencing header of that packet. A quote from RFC 3550: "An example
where a mixer indicates all the talkers whose speech was combined to application is audio conferencing where a mixer indicates all the
produce the outgoing packet, allowing the receiver to indicate the talkers whose speech was combined to produce the outgoing packet,
current talker, even though all the audio packets contain the same allowing the receiver to indicate the current talker, even though all
SSRC identifier (that of the mixer)." the audio packets contain the same SSRC identifier (that of the
mixer)."
6.1.7.4 label of string type 5.7.4 label of string type
The element "label" carries a unique identifier for this stream among The element <label> carries a unique identifier for this stream among
all streams in the conference and is assigned by the focus. The all streams in the conference and is assigned by the focus. The
value of this element corresponds to the "label" media attribute in value of this element corresponds to the SDP "label" media attribute
SDP [12] and defined in [19]. defined in [19].
6.1.7.5 state of media-state-type
The element "state" contains the state of the media stream and can
have the values "active", "inactive", or "muted".
6.1.7.6 snd-status of media-state-type 5.7.5 status of media-status-type
The element "state" contains the state of the sending media stream The element <status> indicates the status in both directions of the
(from the perspective of the endpoint) and can have the values media stream and has the values "sendrecv", "sendonly", "recvonly",
"active", "inactive", or "muted". 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. For example, a muted participant's stream will have the value
of "recvonly".
6.1.7.7 rcv-status state of media-state-type 5.7.6 call of call-type
The element "state" contains the state of the receiving media stream The <call> element is a general container for providing call
(from the perspective of the endpoint) and can have the values signaling detailed information. Note that privacy policies MUST be
"active", "inactive", or "muted". consulted before revealing this information to third-party
participants.
6.1.7.8 call of call-type Specifically, the <sip> sub-element contains the SIP dialog
identifier of the endpoint's dialog with the focus. The element
includes sub-elements <display-text>, <call-id>, <to-tag>,
<from-tag>.
The "call" element contains the "sip" sub-element which contains the In future, the <call> element can be expanded to include other call
SIP dialog identifier of the endpoint's dialog with the focus. The signaling protocol identifiers.
"sip" element includes sub-elements "display-text", "call-id",
"to-tag", "from-tag"
7. Schema 6. XML Schema
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<xs:schema targetNamespace="urn:ietf:params:xml:ns:conference-info" xmlns:tns="urn:ietf:params:xml:ns:conference-info" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="urn:ietf:params:xml:ns:conference-info" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:schema targetNamespace="urn:ietf:params:xml:ns:conference-info" xmlns:tns="urn:ietf:params:xml:ns:conference-info" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="urn:ietf:params:xml:ns:conference-info" elementFormDefault="qualified" attributeFormDefault="unqualified">
<!-- <!--
This import brings in the XML language attribute xml:lang This import brings in the XML language attribute xml:lang
--> -->
<xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/03/xml.xsd" /> <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/03/xml.xsd" />
<!-- <!--
CONFERENCE ELEMENT CONFERENCE ELEMENT
skipping to change at page 25, line 18 skipping to change at page 24, line 18
<xs:schema targetNamespace="urn:ietf:params:xml:ns:conference-info" xmlns:tns="urn:ietf:params:xml:ns:conference-info" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="urn:ietf:params:xml:ns:conference-info" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:schema targetNamespace="urn:ietf:params:xml:ns:conference-info" xmlns:tns="urn:ietf:params:xml:ns:conference-info" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="urn:ietf:params:xml:ns:conference-info" elementFormDefault="qualified" attributeFormDefault="unqualified">
<!-- <!--
This import brings in the XML language attribute xml:lang This import brings in the XML language attribute xml:lang
--> -->
<xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/03/xml.xsd" /> <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/03/xml.xsd" />
<!-- <!--
CONFERENCE ELEMENT CONFERENCE ELEMENT
--> -->
<xs:element name="conference-info" type="conference-type"/> <xs:element name="conference-info" type="conference-type"/>
<!-- <!--
CONFERENCE TYPE CONFERENCE TYPE
--> -->
<xs:complexType name="conference-type"> <xs:complexType name="conference-type">
<xs:sequence> <xs:sequence>
<xs:element name="conference-description" type="conference-description-type" minOccurs="0"/> <xs:element name="conference-description" type="conference-description-type" minOccurs="0"/>
<xs:element name="host-info" type="host-type" minOccurs="0"/> <xs:element name="host-info" type="host-type" minOccurs="0"/>
<xs:element name="conference-state" type="conference-state-type" minOccurs="0"/> <xs:element name="conference-state" type="conference-state-type" minOccurs="0"/>
<xs:element name="user" type="user-type" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="users" type="users-type" minOccurs="0"/>
<xs:element name="sidebars-by-ref" type="uris-type" minOccurs="0"/> <xs:element name="sidebars-by-ref" type="uris-type" minOccurs="0"/>
<xs:element name="sidebar-by-val" type="conference-type" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="sidebars-by-val" type="sidebars-by-val-type" minOccurs="0"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="entity" type="xs:anyURI" use="required"/> <xs:attribute name="entity" type="xs:anyURI" use="required"/>
<xs:attribute name="state" type="state-type" use="optional"/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:attribute name="version" type="xs:string" use="optional"/> <xs:attribute name="version" type="xs:unsignedInt" use="optional"/>
<xs:anyAttribute/> <xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
STATE TYPE STATE TYPE
--> -->
<xs:simpleType name="state-type"> <xs:simpleType name="state-type">
<xs:restriction base="xs:string"> <xs:restriction base="xs:string">
<xs:enumeration value="full"/> <xs:enumeration value="full"/>
<xs:enumeration value="partial"/> <xs:enumeration value="partial"/>
<xs:enumeration value="deleted"/> <xs:enumeration value="deleted"/>
</xs:restriction> </xs:restriction>
</xs:simpleType> </xs:simpleType>
skipping to change at page 25, line 46 skipping to change at page 25, line 5
<!-- <!--
STATE TYPE STATE TYPE
--> -->
<xs:simpleType name="state-type"> <xs:simpleType name="state-type">
<xs:restriction base="xs:string"> <xs:restriction base="xs:string">
<xs:enumeration value="full"/> <xs:enumeration value="full"/>
<xs:enumeration value="partial"/> <xs:enumeration value="partial"/>
<xs:enumeration value="deleted"/> <xs:enumeration value="deleted"/>
</xs:restriction> </xs:restriction>
</xs:simpleType> </xs:simpleType>
<!-- <!--
CONFERENCE DESCRIPTION TYPE CONFERENCE DESCRIPTION TYPE
--> -->
<xs:complexType name="conference-description-type"> <xs:complexType name="conference-description-type">
<xs:sequence> <xs:sequence>
<xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="display-text" type="xs:string" minOccurs="0"/>
<xs:element name="subject" type="xs:string" minOccurs="0"/> <xs:element name="subject" type="xs:string" minOccurs="0"/>
<xs:element name="free-text" type="xs:string" minOccurs="0"/> <xs:element name="free-text" type="xs:string" minOccurs="0"/>
<xs:element name="keywords" type="keywords-type" minOccurs="0"/> <xs:element name="keywords" type="keywords-type" minOccurs="0"/>
<xs:element name="web-page" type="xs:anyURI" minOccurs="0"/>
<xs:element name="conf-uris" type="uris-type" minOccurs="0"/> <xs:element name="conf-uris" type="uris-type" minOccurs="0"/>
<xs:element name="service-uris" type="uris-type" minOccurs="0"/> <xs:element name="service-uris" type="uris-type" minOccurs="0"/>
<xs:element name="maximum-user-count" type="user-count-type" minOccurs="0"/> <xs:element name="maximum-user-count" type="user-count-type" minOccurs="0"/>
<xs:element name="available-media" type="conference-medias-type" minOccurs="0"/> <xs:element name="available-media" type="conference-medias-type" minOccurs="0"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="state" type="state-type" use="optional"/>
<xs:anyAttribute/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
HOST TYPE HOST TYPE
--> -->
<xs:complexType name="host-type"> <xs:complexType name="host-type">
<xs:sequence> <xs:sequence>
<xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="display-text" type="xs:string" minOccurs="0"/>
<xs:element name="web-page" type="xs:anyURI" minOccurs="0"/> <xs:element name="web-page" type="xs:anyURI" minOccurs="0"/>
<xs:element name="uris" type="uris-type" minOccurs="0"/> <xs:element name="uris" type="uris-type" minOccurs="0"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="state" type="state-type" use="optional"/>
<xs:anyAttribute/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
CONFERENCE STATE TYPE --> CONFERENCE STATE TYPE
-->
<xs:complexType name="conference-state-type"> <xs:complexType name="conference-state-type">
<xs:sequence> <xs:sequence>
<xs:element name="user-count" type="user-count-type" minOccurs="0"/> <xs:element name="user-count" type="user-count-type" minOccurs="0"/>
<xs:element name="security-level" type="security-level-type" minOccurs="0"/>
<xs:element name="active" type="xs:boolean" minOccurs="0"/> <xs:element name="active" type="xs:boolean" minOccurs="0"/>
<xs:element name="locked" type="xs:boolean" minOccurs="0"/> <xs:element name="locked" type="xs:boolean" minOccurs="0"/>
<xs:element name="recording" type="uris-type" minOccurs="0"/> <xs:element name="recording" type="uris-type" minOccurs="0"/>
<xs:element name="active-media" type="conference-medias-type" minOccurs="0"/> <xs:element name="active-media" type="conference-medias-type" minOccurs="0"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="state" type="state-type" use="optional"/>
<xs:anyAttribute/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
CONFERENCE MEDIAS TYPE CONFERENCE MEDIAS TYPE
--> -->
<xs:complexType name="conference-medias-type"> <xs:complexType name="conference-medias-type">
<xs:sequence> <xs:sequence>
<xs:element name="entry" type="conference-media-type" maxOccurs="unbounded"/> <xs:element name="entry" type="conference-media-type" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="state" type="state-type" use="optional"/>
<xs:anyAttribute/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
CONFERENCE MEDIA TYPE CONFERENCE MEDIA TYPE
--> -->
<xs:complexType name="conference-media-type"> <xs:complexType name="conference-media-type">
<xs:sequence> <xs:sequence>
<xs:element name="proto" type="xs:string"/> <xs:element name="proto" type="xs:string"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:anyAttribute/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
CONFERENCE URIs TYPE URIs TYPE
--> -->
<xs:complexType name="uris-type"> <xs:complexType name="uris-type">
<xs:sequence> <xs:sequence>
<xs:element name="entry" type="uri-type" maxOccurs="unbounded"/> <xs:element name="entry" type="uri-type" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="state" type="state-type" use="optional"/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute/> <xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
CONFERENCE URI TYPE URI TYPE
--> -->
<xs:complexType name="uri-type"> <xs:complexType name="uri-type">
<xs:sequence> <xs:sequence>
<xs:element name="uri" type="xs:anyURI"/> <xs:element name="uri" type="xs:anyURI"/>
<xs:element name="label" type="xs:string" minOccurs="0"/> <xs:element name="display-text" type="xs:string" minOccurs="0"/>
<xs:element name="purpose" type="xs:string" minOccurs="0"/>
<xs:element name="modified" type="execution-type" minOccurs="0"/> <xs:element name="modified" type="execution-type" minOccurs="0"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:anyAttribute/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
USER COUNT TYPE USER COUNT TYPE
--> -->
<xs:complexType name="user-count-type"> <xs:complexType name="user-count-type">
<xs:sequence> <xs:sequence>
<xs:element name="entry" type="count-type" maxOccurs="unbounded"/> <xs:element name="entry" type="count-type" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="state" type="state-type" use="optional"/>
<xs:anyAttribute/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
COUNT TYPE COUNT TYPE
--> -->
<xs:complexType name="count-type"> <xs:complexType name="count-type">
<xs:sequence> <xs:sequence>
<xs:element name="role" type="user-role-type"/> <xs:element name="role" type="xs:string"/>
<xs:element name="count" type="xs:nonNegativeInteger"/> <xs:element name="count" type="xs:nonNegativeInteger"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:anyAttribute/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!--
SECURITY LEVEL TYPE
-->
<xs:simpleType name="security-level-type">
<xs:restriction base="xs:string">
<xs:enumeration value="none"/>
<xs:enumeration value="low"/>
<xs:enumeration value="medium"/>
<xs:enumeration value="high"/>
</xs:restriction>
</xs:simpleType>
<!-- <!--
KEWORDS TYPE KEWORDS TYPE
--> -->
<xs:simpleType name="keywords-type"> <xs:simpleType name="keywords-type">
<xs:list itemType="xs:string"/> <xs:list itemType="xs:string"/>
</xs:simpleType> </xs:simpleType>
<!--
USERS TYPE
-->
<xs:complexType name="users-type">
<xs:sequence>
<xs:element name="user" type="user-type" minOccurs="0" maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
<!-- <!--
USER TYPE USER TYPE
--> -->
<xs:complexType name="user-type"> <xs:complexType name="user-type">
<xs:sequence> <xs:sequence>
<xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="display-text" type="xs:string" minOccurs="0"/>
<xs:element name="associated-aors" type="uris-type" minOccurs="0"/> <xs:element name="associated-aors" type="uris-type" minOccurs="0"/>
<xs:element name="roles" type="user-roles-type" minOccurs="0"/> <xs:element name="roles" type="user-roles-type" minOccurs="0"/>
<xs:element name="language" type="xs:language" minOccurs="0"/> <xs:element name="language" type="xs:language" minOccurs="0"/>
<xs:element name="cascaded-focus" type="xs:anyURI" minOccurs="0"/> <xs:element name="cascaded-focus" type="xs:anyURI" minOccurs="0"/>
<xs:element name="endpoint" type="endpoint-type" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="endpoint" type="endpoint-type" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="entity" type="xs:anyURI"/> <xs:attribute name="entity" type="xs:anyURI"/>
<xs:attribute name="state" type="state-type" use="optional"/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute/> <xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
USER ROLES TYPE USER ROLES TYPE
--> -->
<xs:complexType name="user-roles-type"> <xs:complexType name="user-roles-type">
<xs:sequence> <xs:sequence>
<xs:element name="entry" type="user-role-type" maxOccurs="unbounded"/> <xs:element name="entry" type="xs:string" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="state" type="state-type" use="optional"/>
<xs:anyAttribute/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
</xs:complexType> <xs:anyAttribute namespace="##other"/>
<!--
USER ROLE TYPE
-->
<xs:complexType name="user-role-type">
<xs:choice>
<xs:element name="label" type="xs:string"/>
</xs:choice>
<xs:attribute name="conf-template" type="xs:string" use="optional"/>
</xs:complexType> </xs:complexType>
<!-- <!--
ENDPOINT TYPE ENDPOINT TYPE
--> -->
<xs:complexType name="endpoint-type"> <xs:complexType name="endpoint-type">
<xs:sequence> <xs:sequence>
<xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="display-text" type="xs:string" minOccurs="0"/>
<xs:element name="referred" type="execution-type" minOccurs="0"/> <xs:element name="referred" type="execution-type" minOccurs="0"/>
<xs:element name="state" type="endpoint-state-type" minOccurs="0"/> <xs:element name="status" type="endpoint-status-type" minOccurs="0"/>
<xs:element name="whispering-to" type="uris-type" minOccurs="0"/>
<xs:element name="joining-method" type="joining-type" minOccurs="0"/> <xs:element name="joining-method" type="joining-type" minOccurs="0"/>
<xs:element name="joining-info" type="execution-type" minOccurs="0"/> <xs:element name="joining-info" type="execution-type" minOccurs="0"/>
<xs:element name="disconnection-method" type="disconnection-type" minOccurs="0"/> <xs:element name="disconnection-method" type="disconnection-type" minOccurs="0"/>
<xs:element name="disconnection-info" type="execution-type" minOccurs="0"/> <xs:element name="disconnection-info" type="execution-type" minOccurs="0"/>
<xs:element name="media" type="media-type" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="media" type="media-type" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="entity" type="xs:anyURI"/> <xs:attribute name="entity" type="xs:anyURI"/>
<xs:attribute name="state" type="state-type" use="optional"/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute/> <xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
ENDPOINT STATE TYPE ENDPOINT STATUS TYPE
--> -->
<xs:simpleType name="endpoint-state-type"> <xs:simpleType name="endpoint-status-type">
<xs:restriction base="xs:string"> <xs:restriction base="xs:string">
<xs:enumeration value="pending"/> <xs:enumeration value="pending"/>
<xs:enumeration value="dialing-out"/> <xs:enumeration value="dialing-out"/>
<xs:enumeration value="dialing-in"/> <xs:enumeration value="dialing-in"/>
<xs:enumeration value="alerting"/> <xs:enumeration value="alerting"/>
<xs:enumeration value="on-hold"/> <xs:enumeration value="on-hold"/>
<xs:enumeration value="connected"/> <xs:enumeration value="connected"/>
<xs:enumeration value="muted-via-focus"/> <xs:enumeration value="muted-via-focus"/>
<xs:enumeration value="disconnecting"/> <xs:enumeration value="disconnecting"/>
<xs:enumeration value="disconnected"/> <xs:enumeration value="disconnected"/>
skipping to change at page 30, line 29 skipping to change at page 30, line 10
<!-- <!--
DISCONNECTION TYPE DISCONNECTION TYPE
--> -->
<xs:simpleType name="disconnection-type"> <xs:simpleType name="disconnection-type">
<xs:restriction base="xs:string"> <xs:restriction base="xs:string">
<xs:enumeration value="departed"/> <xs:enumeration value="departed"/>
<xs:enumeration value="booted"/> <xs:enumeration value="booted"/>
<xs:enumeration value="failed"/> <xs:enumeration value="failed"/>
</xs:restriction> </xs:restriction>
</xs:simpleType> </xs:simpleType>
<!-- <!--
EXECUTION TYPE EXECUTION TYPE
--> -->
<xs:complexType name="execution-type"> <xs:complexType name="execution-type">
<xs:sequence> <xs:sequence>
<xs:element name="when" type="xs:dateTime" minOccurs="0"/> <xs:element name="when" type="xs:dateTime" minOccurs="0"/>
<xs:element name="reason" type="xs:string" minOccurs="0"/> <xs:element name="reason" type="xs:string" minOccurs="0"/>
<xs:element name="by" type="xs:anyURI" minOccurs="0"/> <xs:element name="by" type="xs:anyURI" minOccurs="0"/>
</xs:sequence> </xs:sequence>
<xs:anyAttribute/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
MEDIA TYPE MEDIA TYPE
--> -->
<xs:complexType name="media-type"> <xs:complexType name="media-type">
<xs:sequence> <xs:sequence>
<xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="display-text" type="xs:string" minOccurs="0"/>
<xs:element name="proto" type="xs:string" minOccurs="0"/> <xs:element name="proto" type="xs:string" minOccurs="0"/>
<xs:element name="ssrc" type="xs:string" minOccurs="0"/> <xs:element name="src-id" type="xs:string" minOccurs="0"/>
<xs:element name="label" type="xs:string" minOccurs="0"/> <xs:element name="label" type="xs:string" minOccurs="0"/>
<xs:element name="state" type="media-state-type" minOccurs="0"/> <xs:element name="status" type="media-status-type" minOccurs="0"/>
<xs:element name="snd-status" type="media-state-type" minOccurs="0"/>
<xs:element name="rcv-status" type="media-state-type" minOccurs="0"/>
<xs:element name="call" type="call-type" minOccurs="0"/> <xs:element name="call" type="call-type" minOccurs="0"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="entity" type="xs:string" use="required"/>
<xs:attribute name="state" type="state-type" use="optional"/> <xs:attribute name="id" type="xs:string" use="required"/>
<xs:anyAttribute/> <xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
MEDIA STATUS TYPE MEDIA STATUS TYPE
--> -->
<xs:simpleType name="media-state-type"> <xs:simpleType name="media-status-type">
<xs:restriction base="xs:string"> <xs:restriction base="xs:string">
<xs:enumeration value="active"/> <xs:enumeration value="recvonly"/>
<xs:enumeration value="sendonly"/>
<xs:enumeration value="sendrecv"/>
<xs:enumeration value="inactive"/> <xs:enumeration value="inactive"/>
<xs:enumeration value="muted"/>
</xs:restriction> </xs:restriction>
</xs:simpleType> </xs:simpleType>
<!-- <!--
CALL TYPE CALL TYPE
--> -->
<xs:complexType name="call-type"> <xs:complexType name="call-type">
<xs:choice> <xs:choice>
<xs:element name="sip" type="sip-dialog-id-type"/> <xs:element name="sip" type="sip-dialog-id-type"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:choice> </xs:choice>
<xs:anyAttribute/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
SIP DIALOG ID TYPE SIP DIALOG ID TYPE
--> -->
<xs:complexType name="sip-dialog-id-type"> <xs:complexType name="sip-dialog-id-type">
<xs:sequence> <xs:sequence>
<xs:element name="display-text" type="xs:string" minOccurs="0"/> <xs:element name="display-text" type="xs:string" minOccurs="0"/>
<xs:element name="dialog-id" type="xs:string"/> <xs:element name="call-id" type="xs:string"/>
<xs:element name="from-tag" type="xs:string"/> <xs:element name="from-tag" type="xs:string"/>
<xs:element name="to-tag" type="xs:string"/> <xs:element name="to-tag" type="xs:string"/>
<xs:element name="extended" type="extended-type" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:anyAttribute/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
<!-- <!--
EXTENDED TYPE SIDEBARS BY VAL TYPE
--> -->
<xs:complexType name="extended-type"> <xs:complexType name="sidebars-by-val-type">
<xs:sequence> <xs:sequence>
<xs:any minOccurs="0" maxOccurs="unbounded"/> <xs:element name="entry" type="conference-type" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence> </xs:sequence>
<xs:attribute name="target-namespace" type="xs:string" use="required"/>
<xs:attribute name="state" type="state-type" use="optional" default="full"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType> </xs:complexType>
</xs:schema> </xs:schema>
8. Examples 7. Examples
8.1 Basic Example 7.1 Basic Example
The following is an example conference information document: The following is an example conference information document:
<conference-info entity="sips:conf233@example.com" state="partial" version="5" > <conference-info entity="sips:conf233@example.com" state="partial" version="5" >
<!-- <!--
CONFERENCE INFO CONFERENCE INFO
--> -->
<conference-description> <conference-description>
<subject>Agenda: This month's target</subject> <subject>Agenda: This month's goals</subject>
<service-uris> <service-uris>
<entry> <entry>
<uri>http://salesgroup.example.com/conference-policies/sales-weekly-meeting.xml</uri> <uri> http://sharepoint/salesgroup/</uri>
<label>CPCP</label> <purpose>web-page</purpose>
</entry> </entry>
</service-uris> </service-uris>
</conference-description> </conference-description>
<!-- <!--
CONFERENCE STATE CONFERENCE STATE
--> -->
<conference-state> <conference-state>
<user-count> <user-count>
<entry> <entry>
<role> <role>any</role>
<label>any</label>
</role>
<count>33</count> <count>33</count>
</entry> </entry>
</user-count> </user-count>
<active-media> <active-media>
<entry> <entry>
<proto>audio</proto> <proto>audio</proto>
</entry> </entry>
</active-media> </active-media>
</conference-state> </conference-state>
<users>
<!-- <!--
USER USER
--> -->
<user entity="sip:bob@example.com" state="full"> <user entity="sip:bob@example.com" state="full">
<display-text>Bob Hoskins</display-text> <display-text>Bob Hoskins</display-text>
<!-- <!--
ENDPOINTS ENDPOINTS
--> -->
<endpoint entity="sip:bob@pc33.example.com"> <endpoint entity="sip:bob@pc33.example.com">
<display-text>Bob's Laptop</display-text> <display-text>Bob's Laptop</display-text>
<state>disconnected</state> <status>disconnected</status>
<disconnection-method>departed</disconnection-method> <disconnection-method>departed</disconnection-method>
<disconnection-info> <disconnection-info>
<when>2005-03-04T20:00:00Z</when> <when>2005-03-04T20:00:00Z</when>
<reason>bad voice quality</reason> <reason>bad voice quality</reason>
<by>sip:mike@example.com</by> <by>sip:mike@example.com</by>
</disconnection-info> </disconnection-info>
<!-- <!--
MEDIA MEDIA
--> -->
<media entity="1"> <media id="1">
<display-text>main audio</display-text> <display-text>main audio</display-text>
<proto>audio</proto> <proto>audio</proto>
<ssrc>432424</ssrc> <src-id>432424</src-id>
<label>34567</label> <label>34567</label>
<state>active</state> <status>sendrecv</status>
</media> </media>
</endpoint> </endpoint>
</user> </user>
<!-- <!--
USER USER
--> -->
<user entity="sip:alice@example.net" state="full"> <user entity="sip:alice@example.net" state="full">
<display-text>Alice</display-text> <display-text>Alice</display-text>
<!-- <!--
ENDPOINTS ENDPOINTS
--> -->
<endpoint entity="sip:4kfk4j392jsu@example.net;grid=433kj4j3u"> <endpoint entity="sip:4kfk4j392jsu@example.net;grid=433kj4j3u">
<state>connected</state> <status>connected</status>
<joining-method>dialed-out</joining-method> <joining-method>dialed-out</joining-method>
<joining-info> <joining-info>
<when>2005-03-04T20:00:00Z</when> <when>2005-03-04T20:00:00Z</when>
<by>sip:mike@example.com</by> <by>sip:mike@example.com</by>
</joining-info> </joining-info>
<!-- <!--
MEDIA MEDIA
--> -->
<media entity="1"> <media id="1">
<display-text>main audio</display-text> <display-text>main audio</display-text>
<proto>audio</proto> <proto>audio</proto>
<ssrc>534232</ssrc> <src-id>534232</src-id>
<label>34564</label> <label>34564</label>
<state>active</state> <status>sendrecv</status>
</media> </media>
</endpoint> </endpoint>
</user> </user>
</users>
</conference-info> </conference-info>
8.2 Rich Example 7.2 Rich Example
The following is an example conference information document. In this The following is an example conference information document. In this
example of a partial state notification, there are 32 participants in example of a partial state notification, there are 32 participants in
a voice conference. The user Bob has been booted from the conference a voice conference. The user Bob has been booted from the conference
by Mike due to bad voice quality. Note that there are three sidebars by Mike due to bad voice quality. Note that there are three sidebars
in the conference, two are referenced just by their sidebar URI and in the conference, two are referenced just by their sidebar URIs and
information about the third sidebar is included in this notification. information about the third sidebar is included in this notification.
Also note that while this conference offers both audio and video Also note that while this conference offers both audio and video
capabilities, only audio is currently in use. capabilities, only audio is currently in use.
<conference-info entity="sips:conf233@example.com" state="partial" version="5" > <conference-info entity="sips:conf233@example.com" state="partial" version="5" >
<!-- <!--
CONFERENCE INFO CONFERENCE INFO
--> -->
<conference-description> <conference-description>
<display-text>Weekly Sales Meeting</display-text> <display-text>Weekly Sales Meeting</display-text>
<subject>Agenda: This month's target</subject> <subject>Agenda: This month's goals</subject>
<free-text>xyz</free-text> <free-text>We will start strict on time</free-text>
<keywords>sales, meeting, weekly</keywords> <keywords>sales, meeting, weekly</keywords>
<web-page>http://sharepoint/salesgroup/</web-page>
<conf-uris> <conf-uris>
<entry> <entry>
<uri>tel:+18005671234</uri> <uri>tel:+18005671234</uri>
<label>TTI Bridge</label> <display-text>TTI Bridge</display-text>
</entry> </entry>
<entry> <entry>
<uri>h323:conf545@h323.example.com</uri> <uri>h323:conf545@h323.example.com</uri>
</entry> </entry>
</conf-uris> </conf-uris>
<service-uris> <service-uris>
<entry> <entry>
<uri>http://salesgroup.example.com/conference-policies/sales-weekly-meeting.xml</uri> <uri>http://sharepoint/salesgroup/</uri>
<label>CPCP</label> <purpose>web-page</purpose>
</entry> </entry>
</service-uris> </service-uris>
<maximum-user-count> <maximum-user-count>
<entry> <entry>
<role> <role>any</role>
<label>any</label>
</role>
<count>52</count> <count>52</count>
</entry> </entry>
<entry> <entry>
<role conf-template="Basic"> <role>participant</role>
<label>participant</label>
</role>
<count>50</count> <count>50</count>
</entry> </entry>
</maximum-user-count> </maximum-user-count>
<available-media> <available-media>
<entry> <entry>
<proto>audio</proto> <proto>audio</proto>
</entry> </entry>
<entry> <entry>
<proto>video</proto> <proto>video</proto>
</entry> </entry>
skipping to change at page 36, line 39 skipping to change at page 35, line 35
<uri>sip:sales@example.com</uri> <uri>sip:sales@example.com</uri>
</entry> </entry>
</uris> </uris>
</host-info> </host-info>
<!-- <!--
CONFERENCE STATE CONFERENCE STATE
--> -->
<conference-state> <conference-state>
<user-count> <user-count>
<entry> <entry>
<role> <role>any</role>
<label>any</label>
</role>
<count>33</count> <count>33</count>
</entry> </entry>
<entry> <entry>
<role conf-template="Basic"> <role>participant</role>
<label>participant</label>
</role>
<count>32</count> <count>32</count>
</entry> </entry>
</user-count> </user-count>
<security-level>medium</security-level>
<active>true</active> <active>true</active>
<locked>false</locked> <locked>false</locked>
<recording> <recording>
<entry> <entry>
<uri>http://quicktime.streaming.com/54634/recording.mov</uri> <uri>http://quicktime.streaming.com/54634/recording.mov</uri>
<label>Quicktime</label> <display-text>Quicktime</display-text>
</entry> </entry>
<entry> <entry>
<uri>http://real.streaming.com/54634/recording.ram</uri> <uri>http://real.streaming.com/54634/recording.ram</uri>
</entry> </entry>
</recording> </recording>
<active-media> <active-media>
<entry> <entry>
<proto>audio</proto> <proto>audio</proto>
</entry> </entry>
</active-media> </active-media>
</conference-state> </conference-state>
<!-- <!--
USERS USERS
--> -->
skipping to change at page 37, line 25 skipping to change at page 36, line 18
<active-media> <active-media>
<entry> <entry>
<proto>audio</proto> <proto>audio</proto>
</entry> </entry>
</active-media> </active-media>
</conference-state> </conference-state>
<!-- <!--
USERS USERS
--> -->
<user entity="sip:bob@example.com" state="full"> <users>
<user entity="sip:bob@example.com">
<display-text>Bob Hoskins</display-text> <display-text>Bob Hoskins</display-text>
<associated-aors> <associated-aors>
<entry> <entry>
<uri>mailto:bob@example.com</uri> <uri>mailto:bob@example.com</uri>
<label>email</label> <display-text>email</display-text>
</entry> </entry>
</associated-aors> </associated-aors>
<roles> <roles>
<entry> <entry>participant</entry>
<label>participant</label>
</entry>
</roles> </roles>
<language>en</language> <language>en</language>
<!-- <!--
ENDPOINTS ENDPOINTS
--> -->
<endpoint entity="sip:bob@pc33.example.com"> <endpoint entity="sip:bob@pc33.example.com">
<display-text>Bob's Laptop</display-text> <display-text>Bob's Laptop</display-text>
<referred> <referred>
<when>2005-03-04T20:00:00Z</when> <when>2005-03-04T20:00:00Z</when>
<reason>expert required</reason>
<by>sip:mike@example.com</by> <by>sip:mike@example.com</by>
</referred> </referred>
<state>disconnecting</state> <status>disconnecting</status>
<whispering-to>
<entry>
<uri>sip:rob@example.com</uri>
</entry>
<entry>
<uri>sip:helen@example.com</uri>
</entry>
</whispering-to>
<joining-method>dialed-out</joining-method> <joining-method>dialed-out</joining-method>
<joining-info> <joining-info>
<when>2005-03-04T20:00:00Z</when> <when>2005-03-04T20:00:00Z</when>
<reason>invitation</reason> <reason>invitation</reason>
<by>sip:mike@example.com</by> <by>sip:mike@example.com</by>
</joining-info> </joining-info>
<disconnection-method>booted</disconnection-method> <disconnection-method>booted</disconnection-method>
<disconnection-info> <disconnection-info>
<when>2005-03-04T20:00:00Z</when> <when>2005-03-04T20:00:00Z</when>
<reason>bad voice quality</reason> <reason>bad voice quality</reason>
<by>sip:mike@example.com</by> <by>sip:mike@example.com</by>
</disconnection-info> </disconnection-info>
<!-- <!--
MEDIA MEDIA
--> -->
<media entity="1" state="full"> <media id="1" state="full">
<display-text>main audio</display-text> <display-text>main audio</display-text>
<proto>audio</proto> <proto>audio</proto>
<ssrc>432424</ssrc> <src-id>432424</src-id>
<label>34567</label> <label>34567</label>
<state>active</state> <status>sendrecv</status>
<call> <call>
<sip> <sip>
<display-text>full info</display-text> <display-text>full info</display-text>
<dialog-id>hsjh8980vhsb78</dialog-id> <call-id>hsjh8980vhsb78</call-id>
<from-tag>vav738dvbs</from-tag> <from-tag>vav738dvbs</from-tag>
<to-tag>8954jgjg8432</to-tag> <to-tag>8954jgjg8432</to-tag>
</sip> </sip>
</call> </call>
</media> </media>
</endpoint> </endpoint>
</user> </user>
</users>
<!-- <!--
SIDEBARS BY REFERENCE SIDEBARS BY REFERENCE
--> -->
<sidebars-by-ref> <sidebars-by-ref>
<entry> <entry>
<uri>sips:conf233@example.com; grid=45</uri> <uri>sips:conf233@example.com; grid=45</uri>
<label>sidebar with Carol</label> <display-text>sidebar with Carol</display-text>
</entry> </entry>
<entry> <entry>
<uri>sips:conf233@example.com; grid=21</uri> <uri>sips:conf233@example.com; grid=21</uri>
<label>private sidebar with Peter</label> <display-text>private sidebar with Peter</display-text>
</entry> </entry>
</sidebars-by-ref> </sidebars-by-ref>
<!-- <!--
SIDEBARS BY VALUE SIDEBARS BY VALUE
--> -->
<sidebar-by-val entity="sips:conf233@example.com; grid=77" state="partial"> <sidebars-by-val>
<entry entity="sips:conf233@example.com; grid=77" state="partial">
<users>
<user entity="sip:bob@example.com" state="partial"></user> <user entity="sip:bob@example.com" state="partial"></user>
<user entity="sip:mark@example.com" state="partial"></user> <user entity="sip:mark@example.com" state="partial"></user>
<user entity="sip:dan@example.com" state="partial"></user> <user entity="sip:dan@example.com" state="partial"></user>
</sidebar-by-val> </users>
</entry>
</sidebars-by-val>
</conference-info> </conference-info>
9. Security Considerations 8. Security Considerations
Subscriptions to conference state can reveal very sensitive Subscriptions to conference state can reveal very sensitive
information. For this reason, the document recommends authentication information. For this reason, the document recommends authentication
and authorization, and provides guidelines on sensible authorization and authorization, and provides guidelines on sensible authorization
policies. policies.
Since the data in notifications is sensitive as well, end-to-end SIP Since the data in notifications is sensitive as well, end-to-end SIP
encryption mechanisms using S/MIME SHOULD be used to protect it. encryption mechanisms using S/MIME SHOULD be used to protect it.
Since a focus provides participants identity information using this Since a focus provides participants identity information using this
event package, participant privacy needs to be taken into account. A event package, participant privacy needs to be taken into account. A
focus MUST support requests by participants for privacy. Privacy can focus MUST support requests by participants for privacy. Privacy can
be indicated by the conference policy - for every participant or be indicated by the conference policy - for every participant or
select participants. It can also be indicated in the session select participants. It can also be indicated in the session
signaling. In SIP this can be done using the Privacy header field signaling. In SIP this can be done using the Privacy header field
described in RFC 3323 [8]. For a participant requesting privacy, no described in RFC 3323 [8]. For a participant requesting privacy, no
identity information SHOULD be revealed by the focus such as a URI identity information SHOULD be revealed by the focus such as a URI
(e.g. the Address of Record, Contact, or GRUU). For these cases, (e.g. the Address of Record, Contact, or GRUU). For these cases,
the anonymous URI generation method outlined in section "User the anonymous URI generation method outlined in section Section 5.5
Element" of this document MUST be followed. of this document MUST be followed.
10. IANA Considerations 9. IANA Considerations
This document registers a SIP event package, a new MIME type, This document registers a SIP event package, a new MIME type,
application/conference-info+xml, a new XML namespace, and a new XML application/conference-info+xml, a new XML namespace, and a new XML
schema. schema.
10.1 conference Event Package Registration 9.1 conference Event Package Registration
This specification registers an event package, based on the This specification registers an event package, based on the
registration procedures defined in RFC 3265 [7]. The following is registration procedures defined in RFC 3265 [7]. The following is
the information required for such a registration: the information required for such a registration:
Package Name: conference Package Name: conference
Package or Template-Package: This is a package. Package or Template-Package: This is a package.
Published Document: RFC XXXX (Note to RFC Editor: Please fill in XXXX Published Document: RFC XXXX (Note to RFC Editor: Please fill in XXXX
with the RFC number of this specification). with the RFC number of this specification).
Person to Contact: Jonathan Rosenberg, jdrosen@jdrosen.net. Person to Contact: Jonathan Rosenberg, jdrosen@jdrosen.net.
10.2 application/conference-info+xml MIME Registration 9.2 application/conference-info+xml MIME Registration
MIME media type name: application MIME media type name: application
MIME subtype name: conference-info+xml MIME subtype name: conference-info+xml
Mandatory parameters: none Mandatory parameters: none
Optional parameters: Same as charset parameter application/xml as Optional parameters: Same as charset parameter application/xml as
specified in RFC 3023 [5]. specified in RFC 3023 [5].
Encoding considerations: Same as encoding considerations of Encoding considerations: Same as encoding considerations of
application/xml as specified in RFC 3023 [5]. application/xml as specified in RFC 3023 [5].
Security considerations: See Section 10 of RFC 3023 [5] and Section 9 Security considerations: See Section 10 of RFC 3023 [5] and Section 8
of this specification. of this specification.
Interoperability considerations: none. Interoperability considerations: none.
Published specification: This document. Published specification: This document.
Applications which use this media type: This document type has been Applications which use this media type: This document type has been
used to support SIP conferencing applications. used to support SIP conferencing applications.
Additional Information: Additional Information:
Magic Number: None Magic Number: None
File Extension: .cif or .xml File Extension: .cif or .xml
Macintosh file type code: "TEXT" Macintosh file type code: "TEXT"
Personal and email address for further information: Jonathan Personal and email address for further information: Jonathan
Rosenberg, <jdrosen@jdrosen.net> Rosenberg, <jdrosen@jdrosen.net>
Intended usage: COMMON Intended usage: COMMON
Author/Change controller: The IETF. Author/Change controller: The IETF.
10.3 URN Sub-Namespace Registration for 9.3 URN Sub-Namespace Registration for
urn:ietf:params:xml:ns:conference-info urn:ietf:params:xml:ns:conference-info
This section registers a new XML namespace, as per the guidelines in This section registers a new XML namespace, as per the guidelines in
[1]. RFC 3688 [12].
URI: The URI for this namespace is URI: The URI for this namespace is
urn:ietf:params:xml:ns:conference-info. urn:ietf:params:xml:ns:conference-info.
Registrant Contact: IETF, SIPPING working group, <sipping@ietf.org>, Registrant Contact: IETF, SIPPING working group, <sipping@ietf.org>,
Jonathan Rosenberg <jdrosen@jdrosen.net>. Jonathan Rosenberg <jdrosen@jdrosen.net>.
XML: XML:
BEGIN BEGIN
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN" <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN"
skipping to change at page 42, line 29 skipping to change at page 41, line 29
<title>Conference Information Namespace</title> <title>Conference Information Namespace</title>
</head </head
<body> <body>
<h1>Namespace for Conference Information</h1> <h1>Namespace for Conference Information</h1>
<h2>urn:ietf:params:xml:ns:conference-info</h2> <h2>urn:ietf:params:xml:ns:conference-info</h2>
<p>See <a href="[[[URL of published RFC]]]">RFCXXXX</a>.</p> <p>See <a href="[[[URL of published RFC]]]">RFCXXXX</a>.</p>
</body> </body>
</html> </html>
END END
10.4 XML Schema Registration 9.4 XML Schema Registration
This specification registers a schema, as per the guidelines in in This specification registers a schema, as per the guidelines in RFC
[1]. 3688 [12].
URI: please assign. URI: please assign.
Registrant Contact: IETF, SIPPING Working Group Registrant Contact: IETF, SIPPING Working Group
(sipping@ietf.org), Jonathan Rosenberg (jdrosen@jdrosen.net). (sipping@ietf.org), Jonathan Rosenberg (jdrosen@jdrosen.net).
XML: The XML can be found as the sole content of Section 7. XML: The XML can be found as the sole content of Section 6.
11. Acknowledgements 10. Acknowledgements
The authors would like to thank Dan Petrie, Sean Olson, Alan The authors would like to thank Dan Petrie, Sean Olson, Alan
Johnston, and Rohan Mahy for their comments and inputs. Johnston, Rohan Mahy, Cullen Jennings, and Miguel Garcia for their
comments and inputs.
12. Changes History
12.1 Changes since -05
o General schema clean-up.
o Definition of common types being used by multiple elements.
o Introduction of an "endpoint" element as a part of hierarchy:
user/endpoint/media.
12.2 Changes since -04
o
o "Sidebar-type" has been removed. "Sidebar" conference element is
defined using the general "conference-type".
o "Recording" conference attribute has been replaced with
"recording" and "streaming" elements within "conference-type".
New "recording-type" and "streaming-type" have been introduced.
o Attribute "state" has been added to "user-type".
o Element "media-stream" within "user-type" has been renamed to
"media".
o Element "role" within "user-type" has been introduced.
o The following statuses have been added to "user-status-type":
blocked, pending, calling, ringing, dialing-in, disconnecting,
removed.
o User status "muted-by-focus" has been renamed to
"muted-via-focus".
o Attributes "id" and "state" have been added to "media-type".
o Elements "status", "snd-status" and "rcv-status" have been added
to "media-type".
o Element "dialog-id" has been renamed to "instance".
o "Constructing Coherent State" section has been updated to include
user and media partial notifications.
12.3 Changes since -03
o "Constructing Coherent State" section has been updated.
o In order to support partial notifications, two placeholders
"conference-ids" and "policy-ids" (for "conf-uri" and "policy-uri"
elements, correspondingly) are created.
o Discussion and security considerations regarding anonymous
participation have been added.
o Optional elements "dialog-uri", "info" and "label" per media
stream are added.
12.4 Changes since -02
o State "muted-by-focus" is added to user's status.
o Optional conference attribute "recording" is added.
o Policy URI placeholder (i.e. element "policy-uri") is created.
o Example's syntax is corrected.
o Optional attribute "cascaded-focus" URI per user is added.
o Optional additional conference identifiers (i.e. element
"conf-uri") are added.
o In order to cover all possible cases, participant's status is
expressed using three optional statuses: "status", "joining-mode"
and "disconnection-reason". That is instead of "activity-status",
"history-status" and "is-on-dial-out-list".
12.5 Changes since -01
o Package parameters are removed. Decision about performing
"recursive" membership algorithm is perceived as a focus local
policy.
o General information (i.e. pointers to additional available
services) is removed. The defined XML schema can be extended in
future to include those when XCON work matures.
o Dialog information is removed. It can be obtained by direct
subscription to a dialog package of a participant.
o Media stream information is aligned with SDP definitions (media
and proto) and SSRC attribute is added.
o Participant's status is expressed using two optional statuses:
"activity" and "history". Optional "is-on-a-dial-out-list"
indication is added.
o Normative references to XCON work are removed.
o Optional sidebar rosters are added.
13. References
13.1 Normative References 11. References
[1] Mealling, M., "The IETF XML Registry", 11.1 Normative References
draft-mealling-iana-xmlns-registry-05 (work in progress), June
2003.
[2] Bradner, S., "Key words for use in RFCs to Indicate Requirement [1] Bradner, S., "Key words for use in RFCs to Indicate Requirement
Levels", BCP 14, RFC 2119, March 1997. Levels", BCP 14, RFC 2119, March 1997.
[3] Moats, R., "URN Syntax", RFC 2141, May 1997. [2] Moats, R., "URN Syntax", RFC 2141, May 1997.
[3] Handley, M. and V. Jacobson, "SDP: Session Description
Protocol", RFC 2327, April 1998.
[4] Moats, R., "A URN Namespace for IETF Documents", RFC 2648, [4] Moats, R., "A URN Namespace for IETF Documents", RFC 2648,
August 1999. August 1999.
[5] Murata, M., St. Laurent, S. and D. Kohn, "XML Media Types", RFC [5] Murata, M., St. Laurent, S. and D. Kohn, "XML Media Types", RFC
3023, January 2001. 3023, January 2001.
[6] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., [6] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A.,
Peterson, J., Sparks, R., Handley, M. and E. Schooler, "SIP: Peterson, J., Sparks, R., Handley, M. and E. Schooler, "SIP:
Session Initiation Protocol", RFC 3261, June 2002. Session Initiation Protocol", RFC 3261, June 2002.
skipping to change at page 46, line 42 skipping to change at page 43, line 41
Protocol (SIP)", RFC 3323, November 2002. Protocol (SIP)", RFC 3323, November 2002.
[9] Camarillo, G., Eriksson, G., Holler, J. and H. Schulzrinne, [9] Camarillo, G., Eriksson, G., Holler, J. and H. Schulzrinne,
"Grouping of Media Lines in the Session Description Protocol "Grouping of Media Lines in the Session Description Protocol
(SDP)", RFC 3388, December 2002. (SDP)", RFC 3388, December 2002.
[10] Schulzrinne, H., Casner, S., Frederick, R. and V. Jacobson, [10] Schulzrinne, H., Casner, S., Frederick, R. and V. Jacobson,
"RTP: A Transport Protocol for Real-Time Applications", STD 64, "RTP: A Transport Protocol for Real-Time Applications", STD 64,
RFC 3550, July 2003. RFC 3550, July 2003.
13.2 Informative References [11] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD
63, RFC 3629, November 2003.
[11] Schulzrinne, H., Rao, A. and R. Lanphier, "Real Time Streaming [12] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
Protocol (RTSP)", RFC 2326, April 1998. January 2004.
[12] Handley, M. and V. Jacobson, "SDP: Session Description 11.2 Informative References
Protocol", RFC 2327, April 1998.
[13] Vaha-Sipila, A., "URLs for Telephone Calls", RFC 2806, April [13] Schulzrinne, H., Rao, A. and R. Lanphier, "Real Time Streaming
Protocol (RTSP)", RFC 2326, April 1998.
[14] Vaha-Sipila, A., "URLs for Telephone Calls", RFC 2806, April
2000. 2000.
[14] Levin, O., "H.323 Uniform Resource Locator (URL) Scheme [15] Levin, O., "H.323 Uniform Resource Locator (URL) Scheme
Registration", RFC 3508, April 2003. Registration", RFC 3508, April 2003.
[15] Rosenberg, J., "A Framework for Conferencing with the Session [16] Rosenberg, J., "A Framework for Conferencing with the Session
Initiation Protocol", Initiation Protocol",
draft-ietf-sipping-conferencing-framework-03 (work in draft-ietf-sipping-conferencing-framework-03 (work in
progress), October 2004. progress), October 2004.
[16] Rosenberg, J. and H. Schulzrinne, "An INVITE Inititiated Dialog [17] Rosenberg, J., "An INVITE Inititiated Dialog Event Package for
Event Package for the Session Initiation Protocol (SIP)", the Session Initiation Protocol (SIP)",
draft-ietf-sipping-dialog-package-04 (work in progress), draft-ietf-sipping-dialog-package-05 (work in progress),
February 2004. November 2004.
[17] Koskelainen, P. and H. Khartabil, "Requirements for Conference
Policy Control Protocol", draft-ietf-xcon-cpcp-reqs-04 (work in
progress), August 2004.
[18] Rosenberg, J., "Obtaining and Using Globally Routable User [18] Rosenberg, J., "Obtaining and Using Globally Routable User
Agent (UA) URIs (GRUU) in the Session Initiation Protocol Agent (UA) URIs (GRUU) in the Session Initiation Protocol
(SIP)", draft-ietf-sip-gruu-02 (work in progress), July 2004. (SIP)", draft-ietf-sip-gruu-02 (work in progress), July 2004.
[19] Levin, O. and G. Camarillo, "The SDP (Session Description [19] Levin, O. and G. Camarillo, "The SDP (Session Description
Protocol) Label Attribute", Protocol) Label Attribute",
draft-ietf-mmusic-sdp-media-label-00 (work in progress), draft-ietf-mmusic-sdp-media-label-00 (work in progress),
September 2004. September 2004.
Authors' Addresses Authors' Addresses
Jonathan Rosenberg Jonathan Rosenberg
dynamicsoft Cisco Systems
600 Lanidex Plaza 600 Lanidex Plaza
Parsippany, NJ 07054 Parsippany, NJ 07054
US US
Phone: +1 973 952-5000 Phone: +1 973 952-5000
EMail: jdrosen@dynamicsoft.com EMail: jdrosen@cisco.com
URI: http://www.jdrosen.net URI: http://www.jdrosen.net
Henning Schulzrinne Henning Schulzrinne
Columbia University Columbia University
M/S 0401 M/S 0401
1214 Amsterdam Ave. 1214 Amsterdam Ave.
New York, NY 10027 New York, NY 10027
US US
EMail: schulzrinne@cs.columbia.edu EMail: schulzrinne@cs.columbia.edu
URI: http://www.cs.columbia.edu/~hgs URI: http://www.cs.columbia.edu/~hgs
Orit Levin (editor) Orit Levin (editor)
Microsoft Corporation Microsoft Corporation
One Microsoft Way One Microsoft Way
Redmond, WA 98052 Redmond, WA 98052
USA US
EMail: oritl@microsoft.com EMail: oritl@microsoft.com
Intellectual Property Statement Intellectual Property Statement
The IETF takes no position regarding the validity or scope of any The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has might or might not be available; nor does it represent that it has
 End of changes. 

This html diff was produced by rfcdiff 1.23, available from http://www.levkowetz.com/ietf/tools/rfcdiff/