idnits 2.17.1
draft-ietf-siprec-metadata-08.txt:
Checking boilerplate required by RFC 5378 and the IETF Trust (see
https://trustee.ietf.org/license-info):
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt:
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/checklist :
----------------------------------------------------------------------------
No issues found here.
Miscellaneous warnings:
----------------------------------------------------------------------------
== The copyright year in the IETF Trust and authors Copyright Line does not
match the current year
-- The document date (October 17, 2012) is 4180 days in the past. Is this
intentional?
Checking references for intended status: Proposed Standard
----------------------------------------------------------------------------
(See RFCs 3967 and 4897 for information about using normative references
to lower-maturity documents in RFCs)
** Obsolete normative reference: RFC 2141 (Obsoleted by RFC 8141)
** Obsolete normative reference: RFC 4566 (Obsoleted by RFC 8866)
== Outdated reference: A later version (-12) exists of
draft-ietf-siprec-architecture-06
Summary: 2 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--).
Run idnits with the --verbose option for more detailed information about
the items above.
--------------------------------------------------------------------------------
1 SIPREC Ram Mohan. Ravindranath
2 Internet-Draft Cisco Systems, Inc.
3 Intended status: Standards Track Parthasarathi. Ravindran
4 Expires: April 20, 2013 Nokia Siemens Networks
5 Paul. Kyzivat
6 Huawei
7 October 17, 2012
9 Session Initiation Protocol (SIP) Recording Metadata
10 draft-ietf-siprec-metadata-08
12 Abstract
14 Session recording is a critical requirement in many communications
15 environments such as call centers and financial trading. In some of
16 these environments, all calls must be recorded for regulatory,
17 compliance, and consumer protection reasons. Recording of a session
18 is typically performed by sending a copy of a media stream to a
19 recording device. This document describes the metadata model as
20 viewed by Session Recording Server(SRS) and the Recording metadata
21 format.
23 Status of this Memo
25 This Internet-Draft is submitted in full conformance with the
26 provisions of BCP 78 and BCP 79.
28 Internet-Drafts are working documents of the Internet Engineering
29 Task Force (IETF). Note that other groups may also distribute
30 working documents as Internet-Drafts. The list of current Internet-
31 Drafts is at http://datatracker.ietf.org/drafts/current/.
33 Internet-Drafts are draft documents valid for a maximum of six months
34 and may be updated, replaced, or obsoleted by other documents at any
35 time. It is inappropriate to use Internet-Drafts as reference
36 material or to cite them other than as "work in progress."
38 This Internet-Draft will expire on April 20, 2013.
40 Copyright Notice
42 Copyright (c) 2012 IETF Trust and the persons identified as the
43 document authors. All rights reserved.
45 This document is subject to BCP 78 and the IETF Trust's Legal
46 Provisions Relating to IETF Documents
47 (http://trustee.ietf.org/license-info) in effect on the date of
48 publication of this document. Please review these documents
49 carefully, as they describe your rights and restrictions with respect
50 to this document. Code Components extracted from this document must
51 include Simplified BSD License text as described in Section 4.e of
52 the Trust Legal Provisions and are provided without warranty as
53 described in the Simplified BSD License.
55 Table of Contents
57 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
58 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
59 3. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 4
60 4. Metadata Model . . . . . . . . . . . . . . . . . . . . . . . . 5
61 5. Recording Metadata Format . . . . . . . . . . . . . . . . . . 6
62 5.1. XML data format . . . . . . . . . . . . . . . . . . . . . 6
63 5.1.1. Namespace . . . . . . . . . . . . . . . . . . . . . . 7
64 5.1.2. recording . . . . . . . . . . . . . . . . . . . . . . 7
65 6. Recording Metadata classes . . . . . . . . . . . . . . . . . . 7
66 6.1. Recording Session . . . . . . . . . . . . . . . . . . . . 7
67 6.1.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 8
68 6.1.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 8
69 6.1.3. XML element . . . . . . . . . . . . . . . . . . . . . 8
70 6.2. Communication Session Group . . . . . . . . . . . . . . . 9
71 6.2.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 9
72 6.2.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 9
73 6.2.3. XML element . . . . . . . . . . . . . . . . . . . . . 10
74 6.3. Communication Session . . . . . . . . . . . . . . . . . . 10
75 6.3.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 11
76 6.3.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 11
77 6.3.3. XML element . . . . . . . . . . . . . . . . . . . . . 12
78 6.4. CSRSAssociation . . . . . . . . . . . . . . . . . . . . . 12
79 6.4.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 13
80 6.4.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 13
81 6.4.3. XML element . . . . . . . . . . . . . . . . . . . . . 13
82 6.5. Participant . . . . . . . . . . . . . . . . . . . . . . . 13
83 6.5.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 14
84 6.5.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 14
85 6.5.3. XML element . . . . . . . . . . . . . . . . . . . . . 14
86 6.6. ParticipantCSAssociation . . . . . . . . . . . . . . . . . 15
87 6.6.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 15
88 6.6.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 16
89 6.6.3. XML element . . . . . . . . . . . . . . . . . . . . . 16
90 6.7. Media Stream . . . . . . . . . . . . . . . . . . . . . . . 16
91 6.7.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 17
92 6.7.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 17
93 6.7.3. XML element . . . . . . . . . . . . . . . . . . . . . 17
94 6.8. ParticipantStream Association . . . . . . . . . . . . . . 17
95 6.8.1. Attributes . . . . . . . . . . . . . . . . . . . . . . 18
96 6.8.2. Linkages . . . . . . . . . . . . . . . . . . . . . . . 18
97 6.8.3. XML element . . . . . . . . . . . . . . . . . . . . . 18
98 6.9. associate-time/disassociate-time . . . . . . . . . . . . . 18
99 6.10. Unique ID format . . . . . . . . . . . . . . . . . . . . . 19
100 7. SIP Recording Metadata Example . . . . . . . . . . . . . . . . 19
101 7.1. Complete SIP Recording Metadata Example . . . . . . . . . 19
102 7.2. Partial Update of Recording metadata XML body . . . . . . 21
103 8. XML Schema definition for Recording metadata . . . . . . . . . 21
104 9. Security Considerations . . . . . . . . . . . . . . . . . . . 25
105 9.1. Connection Security . . . . . . . . . . . . . . . . . . . 25
106 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 25
107 10.1. SIP recording metadata Schema Registration . . . . . . . . 25
108 11. Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . 26
109 12. Appendix A: Metadata Model Object Instances . . . . . . . . . 26
110 12.1. Use case 1: Basic Call . . . . . . . . . . . . . . . . . . 26
111 12.2. Use case 2: Hold/Resume . . . . . . . . . . . . . . . . . 27
112 12.3. Use case 3: Basic call with Transfer . . . . . . . . . . . 29
113 12.4. Conference Use Cases . . . . . . . . . . . . . . . . . . . 30
114 12.4.1. Case 1: . . . . . . . . . . . . . . . . . . . . . . . 31
115 12.4.2. Case 2: . . . . . . . . . . . . . . . . . . . . . . . 33
116 12.4.3. Case 3: . . . . . . . . . . . . . . . . . . . . . . . 35
117 12.4.4. Case 4: . . . . . . . . . . . . . . . . . . . . . . . 36
118 13. Appendix B: Metadata XML schema Instances . . . . . . . . . . 37
119 13.1. Use case 1: Basic Call . . . . . . . . . . . . . . . . . . 37
120 13.2. Use case 2: Hold/resume . . . . . . . . . . . . . . . . . 39
121 13.3. Use case 3: Basic Call with transfer . . . . . . . . . . . 41
122 13.4. Use Case 4: Call disconnect . . . . . . . . . . . . . . . 45
123 14. References . . . . . . . . . . . . . . . . . . . . . . . . . . 46
124 14.1. Normative References . . . . . . . . . . . . . . . . . . . 46
125 14.2. Informative References . . . . . . . . . . . . . . . . . . 47
126 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 47
128 1. Introduction
130 Session recording is a critical requirement in many communications
131 environments such as call centers and financial trading. In some of
132 these environments, all calls must be recorded for regulatory,
133 compliance, and consumer protection reasons. Recording of a session
134 is typically performed by sending a copy of a media stream to a
135 recording device. This document focuses on the Recording metadata
136 which describes the communication session. The document describes a
137 metadata model as viewed by Session Recording Server and the
138 Recording metadata format, the requirements for which are described
139 in [RFC6341] and the architecture for which is described in
140 [I-D.ietf-siprec-architecture].
142 2. Terminology
144 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
145 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
146 document are to be interpreted as described in [RFC2119]. This
147 document only uses these key words when referencing normative
148 statements in existing RFCs."
150 3. Definitions
152 Metadata Model: An abstract representation of metadata using a
153 Unified Modelling Language(UML) class diagram.
155 Metadata classes: Each block in the model represents a class. A
156 class is a construct that is used as a blueprint to create
157 instances(called objects) of itself. The description of each class
158 also has representation of its attributes in a second compartment
159 below the class name.
161 Attributes: Attributes represents the attributes listed in each of
162 the classes. The attributes of a class are listed in the second
163 compartment below the class name. Each instance of class conveys
164 values for these attributes which adds to the recording's Metadata.
166 Linkages: Linkages represents the relationship between the classes in
167 the model. It represents the logical connections betweens classes(or
168 objects) in class diagrams/ object diagrams. The linkages used in
169 the Metadata model of this document are associations.
171 4. Metadata Model
173 Metadata is the information that describes recorded media and the CS
174 to which they relate. Below diagram shows a model for Metadata as
175 viewed by Session Recording Server (SRS).
177 +-------------------------------+
178 | Recording Session (RS) |
179 +-------------------------------+
180 |1..* | 1..*
181 | |
182 | | 0..*
183 | +-----------------+
184 +------------+ | | Communication |
185 | CSRS | | | Session (CS) |
186 | Association|--+ | Group |
187 | | | +-----------------+
188 +------------+ | | 0..1
189 | |
190 |0..* | 1..*
191 +-------------------------------+
192 | Communication Session (CS) |
193 | |
194 +-------------------------------+
195 | 1..* |0..1
196 +-----+ |
197 | | 0..* |0..*
198 | +-------------+ receives +----------------+
199 | | Participant |----------| Media Streams |
200 | | |0..* 0..*| |
201 | | | | |
202 | | | | |
203 | | | sends | |
204 | | |----------| |
205 | | |1.* 0..*| |
206 | +-------------+ +----------------+
207 | | |
208 | | |
209 | +------------------------+------------+
210 | |
211 | |
212 | +------------------+ +----------------------+
213 | |ParticipantCS | | ParticipantStream |
214 +-----------| Association | | Association |
215 | | | |
216 +------------------+ +----------------------+
218 The Metadata model is a class diagram in Unified Modelling
219 Language(UML). The model describes the structure of a metadata in
220 general by showing the classes, their attributes, and the
221 relationships among the classes. Each block in the model above
222 represents a class. The linkages between the classes represents the
223 relationships which can be associations or Composition. The metadata
224 is conveyed from SRC to SRS.
226 The model allows the capture of a snapshot of a recording's Metadata
227 at a given instant in time. Metadata changes to reflect changes in
228 what is being recorded. For example, if in a conference a
229 participant joins SRC sends a snapshot of metadata having that
230 participant information (with attributes like name/AoR pair and
231 associate-time) to the SRS.
233 Some of the metadata is not required to be conveyed explicitly from
234 the SRC to the SRS, if it can be obtained contextually by the
235 SRS(e.g., from SIP or SDP signalling).
237 5. Recording Metadata Format
239 This section gives an overview of Recording Metadata Format. Some
240 data from the metadata model is assumed to be made available to the
241 SRS through Session Description Protocol (SDP)[RFC4566], and
242 therefore this data is not represented in the XML document format
243 specified in this document. SDP attributes describes about different
244 media formats like audio, video. The other metadata attributes like
245 participant details are represented in a new Recording specific XML
246 document namely application/rs-metadata+xml. The SDP label attribute
247 [RFC4574] provides an identifier by which a metadata XML document can
248 refer to a specific media description in the SDP sent from the SRC to
249 the SRS.
251 The XML document format can be used to represent either the complete
252 metadata or a partial update to the metadata. The latter includes
253 only elements that have changed compared to the previously reported
254 metadata.
256 5.1. XML data format
258 Recording Metadata document is an XML document. recording element
259 MUST be present in all recording metadata XML document. recording
260 acts as container for all other elements in this XML document.
262 Recording object is a XML document. It MUST have the XML declaration
263 and it SHOULD contain an encoding declaration in the XML declaration,
264 e.g., "". If the charset
265 parameter of the MIME content type declaration is present and it is
266 different from the encoding declaration, the charset parameter takes
267 precedence.
269 Every application conforming to this specification MUST accept the
270 UTF-8 character encoding to ensure the minimal interoperability.
272 Syntax and semantics error in recording XML document has to be
273 informed to the originator using application specific mechanism.
275 5.1.1. Namespace
277 The namespace URI for elements defined by this specification is a
278 Uniform Resource Namespace (URN) [RFC2141], using the namespace
279 identifier 'ietf' defined by [RFC2648] and extended by [RFC3688].
281 The URN is as follows: urn:ietf:params:xml:ns:recording
283 5.1.2. recording
285 recording element MUST contain an xmlns namespace attribute with
286 value as urn:ietf:params:xml:ns:recording. One recording element
287 MUST be present in the all recording metadata XML document.
289 dataMode element shows whether the XML document is complete document
290 or partial update. The default value is complete.
292 6. Recording Metadata classes
294 This section describes each class of the metadata model, and the
295 attributes of each class. This section also describes how different
296 classes are linked and the XML element for each of them.
298 6.1. Recording Session
299 +-------------------------------+
300 | Recording Session (RS) |
301 +-------------------------------+
302 | |
303 | Start/End Time |
304 | |
305 | |
306 | |
307 +-------------------------------+
308 |1..* | 1..*
309 | |
310 |0..* | 0..*
311 Communication Communication
312 Session Session Group(CS Group)
314 Each instance of a Recording Session class (namely the Recording
315 Session Object) represents a SIP session created between an SRC and
316 SRS for the purpose of recording a Communication Session.
318 6.1.1. Attributes
320 A Recording Session class has the following attributes:
321 o Start/End Time - Represents the Start/End time of a Recording
322 Session object.
324 6.1.2. Linkages
326 Each instance of Recording Session has:
328 o Zero or more instances of Communication Session Group. CSG may be
329 zero because it is optional metadata object. Also the allowance
330 of zero instances is to accommodate persistent recording, where
331 there may be none.
332 o Zero or more instances of Communication Session objects.
334 6.1.3. XML element
336 Recording Session object is represented by recording XML element.
337 That in turn relies on the SIP/SDP session with which the XML
338 document is associated to provide some of the attributes of the
339 Recording Session element.
341 Start and End time value are derivable from Date header(if present in
342 SIP message) in RS. In cases where Date header is not present,
343 Start/End time are derivable from the time at which SRS receives the
344 notification of SIP message to setup RS / disconnect RS.
346 6.2. Communication Session Group
348 Recording Session (RS)
349 | 1..*
350 |
351 | 0..*
352 +-------------------------------+
353 | Communication Session |
354 | Group |
355 +-------------------------------+
356 | Unique-ID |
357 | associate-time |
358 | disassociate-time |
359 | |
360 +-------------------------------+
361 | 0..1
362 |
363 | 1..*
364 Communication Session (CS)
366 One instance of a Communication Session Group class (namely the
367 Communication Session Group object) provides association or linking
368 of Communication Sessions.
370 6.2.1. Attributes
372 A CS Group has the following attributes:
373 o Unique-ID - This Unique-ID is to group different CSs that are
374 related. SRC (or SRS) is responsible for ensuring the uniqueness
375 of Unique-ID in case multiple SRC interacts with the same SRS.
376 The mechanism by which SRC groups the CS is outside the scope of
377 SIPREC.
378 o Associate-time - Associate-time for CS-Group shall be calculated
379 by SRC as the time when a grouping is formed. The rules that
380 determine how a grouping of different Communication Session
381 objects is done by SRC is outside the scope of SIPREC.
382 o Disassociate-time - Disassociate-time for CS-Group shall be
383 calculated by SRC as the time when the grouping ends
385 6.2.2. Linkages
387 The linkages between Communication Session Group class and other
388 classes is association. A communication Session Group is associated
389 with RS and CS in the following manner:
391 o There is one or more Recording Session objects per Communication
392 Session Group.
393 o Each Communication Session Group object has to be associated with
394 one or more RS [Here each RS can be setup by the potentially
395 different SRCs]
396 o There is one or more Communication Sessions per CS Group [e.g.
397 Consult Transfer]
399 6.2.3. XML element
401 Group element is an optional element provides the information about
402 the communication session group
404 Each communication session group (CSG)object is represented using one
405 group element. Each group element has unique Base 64 URN UUID
406 attribute which helps to uniquely identify CSG.
408 6.3. Communication Session
410 Recording Communication
411 Session Session Group(CS Group)
412 |1..* | 0..1
413 | |
414 |0..* | 1..*
415 +-------------------------------+
416 | Communication Session (CS) |
417 | |
418 +-------------------------------+
419 | CS Identifier |
420 | Termination Reason |
421 | Start-time |
422 | Stop-time |
423 +-------------------------------+
424 | |
425 | 0..* |0..1
426 | |
427 | 0..* |0..*
428 Participant Media Stream
430 A Communication Session class and its object in the metadata model
431 represents Communication Session and its properties needed as seen by
432 SRC.
434 6.3.1. Attributes
436 A communication Session class has the following attributes:
438 o Termination Reason - This represents the reason why a CS was
439 terminated. The communication session MAY contain a Call
440 Termination Reason. This MAY be derived from SIP Reason header
441 [RFC3326] of CS.
442 o CS Identifier - This attribute is used to uniquely identify a CS.
443 o Start-time - This optional attribute represents start time of CS
444 as seen by SRC
445 o Stop-time - This optional attribute represents stop time of CS as
446 seen by SRC
448 This document does not specify attributes relating to what should
449 happen to a recording of a CS after it has been delivered to the SRS,
450 e.g., how long to retain the recording, what access controls to
451 apply. The SRS is assumed to behave in accordance with policy. The
452 ability for the SRC to influence this policy is outside the scope of
453 this document. However if there are implementations where SRC has
454 enough information, this could be sent as Extension Data attached to
455 CS
457 6.3.2. Linkages
459 A Communication Session is linked to CS-Group, Participant, Media
460 Stream and Recording Session classes using the association
461 relationship. Association between CS and Participant allows:
463 o CS to have atleast zero or more participants
464 o Participant is associated with zero or more CSs. This includes
465 participants who are not directly part of any CS. An example of
466 such a case is participants in a premixed media stream. The SRC
467 may have knowledge of such Participants, yet not have any
468 signaling relationship with them. This might arise if one
469 participant in CS is a conf focus. To summarize even if SRC does
470 not have direct signalling relationships with all participants in
471 a CS, it should nevertheless create a Participant object for each
472 participant that it knows about.
473 o The model also allows participants in CS that are not participants
474 in the media. An example is the identity of a 3pcc controller
475 that has initiated a CS to two or more participants of the CS.
476 Another example is the identity of a conference focus. Of course
477 a focus is probably in the media, but since it may only be there
478 as a mixer, it may not report itself as a participant in any of
479 the media streams.
481 Association between CS and Media Stream allows:
483 o A CS to have zero or more Streams
484 o A stream can be associated with at most one CS. Stream in
485 persistent RS is not required to be associated with any CS before
486 CS is created and hence the zero association is allowed.
488 Association between CS and RS allows:
490 o Each instance of RS has Zero or more instances of Communication
491 Session objects.
492 o Each CS has to be associated with one more RS [ Here each RS can
493 be potentially setup by different SRCs]
495 6.3.3. XML element
497 Session element provides the information about the communication
498 session
500 Each communication session(CS) object is represented by one session
501 element. Each session element has unique Base 64 URN UUID attribute
502 which helps to uniquely identify CS.
504 Reason element MAY be included to represent the Termination Reason
505 attribute. group-ref element MAY exist to indicate the group where
506 the mentioned session belongs.
508 6.4. CSRSAssociation
510 1..* 0..*
511 Recording Communication
512 Session ----------+---------- Session
513 |
514 |
515 |
516 +-------------------+
517 | CSRSAssociation |
518 +-------------------+
519 | Association-Time |
520 | Disassociaton-Time|
521 +-------------------+
523 A CSRS Association class and its objects has attributes of CS object
524 which are attributes of association of a session to a RS.
526 6.4.1. Attributes
528 CSRS association class has the following attributes:
530 o Associate-time - associate-time is calculated by SRC as the time
531 it sees a CS is associated to a RS
532 o Disassociate-time- Disassociate-time is calculated by SRC as the
533 time it see a CS disassociate from a RS.
534 It is possible that a given CS can have multiple associate/
535 disassociate times within given RS.
537 6.4.2. Linkages
539 CSRS association class is linked to CS and RS classes. There are no
540 cardinalties for this linkage.
542 6.4.3. XML element
544 sessionrecordingassoc is the XML element to represent CSRS
545 association object. session URN UUID is used to uniquely identify
546 this element and link with the specific session.
548 6.5. Participant
550 Communication Session (CS)
551 | 0..*
552 |
553 | 0..*
554 +-------------------------------+
555 | Participant |
556 | |
557 +-------------------------------+
558 | AoR / Name Pair list |
559 | |
560 | |
561 +-------------------------------+
562 | 0..* 1..*|
563 receives| |sends
564 | 0..* 0..*|
565 Media Stream
567 A Participant class and its objects has information about a device
568 that is part of a CS and/or contributes/consumes media stream(s)
569 belonging to a CS.
571 6.5.1. Attributes
573 Participant has attributes like:
575 o AoR / Name pair list - This attribute is a list of Name/AoR tuple.
576 An AoR MAY be SIP/SIPS/TEL URI. Name represents Participant
577 name(SIP display name) or DN number ( in case it is known). There
578 are cases where a participant can have more than one AoR [e.g.
579 P-Asserted-identity header [RFC3325] which can have both SIP and
580 TEL URIs]
582 This document does not specify other attributes relating to
583 participant e.g. Participant Role, Participant type. An SRC which
584 has information of these attributes can indicate the same as part of
585 extension data to Participant from SRC to SRS.
587 6.5.2. Linkages
589 The participant class is linked to MS and CS class using association
590 relationship. The association between participant and Media Stream
591 allows:
593 o Participant to receives zero or more media streams
594 o Participant to send zero or more media streams. (Same participant
595 provides multiple streams e.g. audio and video)
596 o Media stream to be received by zero or more participants. Its
597 possible, though perhaps unlikely, that a stream is generated but
598 sent only to the SRC and SRS, not to any participant. E.g. In
599 conferencing where all participants are on hold and the SRC is
600 collocated with the focus. Also a media stream may be received by
601 multiple participants (e.g. Whisper calls, side conversations).
602 o Media stream to be sent by one or more participants (pre-mixed
603 streams).
605 Example of a case where a participant receives Zero or more streams -
606 a Supervisor may have side conversation with Agent, while Agent
607 converses with customer.
609 6.5.3. XML element
611 A participant element represents a Participant object.
613 Participant MUST have a NameID complex element which contains AoR as
614 attribute and Name as element. AOR element is SIP/SIPS URI FQDN or
615 IP address which represents the user. name is an optional element to
616 represent display name.
618 Each participant element has unique ID (Base 64 URN UUID) attribute
619 which helps to uniquely identify participant and session Base 64 URN
620 UUID to associate participant with specific session element. Base 64
621 URN UUID of participant MUST used in the scope of CSG and no new Base
622 64 URN UUID has to be created for the same element (participant,
623 stream) between different CS in the same CSG. In case Base 64 URN
624 UUID has to be used permanent, careful usage of Base 64 URN UUID to
625 original AoR has to be decided by the implementers and it is
626 implementer's choice.
628 6.6. ParticipantCSAssociation
630 1..* 0..*
631 Communication
632 Session ----------+---------- Participant
633 |
634 |
635 |
636 +-------------------+
637 | ParticipantCS |
638 | Association |
639 +-------------------+
640 | Capabilities |
641 | Association-Time |
642 | Disassociaton-Time|
643 +-------------------+
645 A participantCS Association class and its objects has attributes of
646 participant object which are attributes of association of a
647 participant to a Session.
649 6.6.1. Attributes
651 ParticipantCS association class has the following attributes:
653 o Associate-time - associate-time is calculated by SRC as the time
654 it sees a participant is associated to CS
655 o Disassociate-time- Disassociate-time is calculated by SRC as the
656 time it see a participant disassociate from a CS. It is possible
657 that a given participant can have multiple associate/disassociate
658 times within given communication session.
659 o Capabilities - A participant capabilities as defined in [RFC3840]
660 which is an optional attribute that includes the capabilities of a
661 participant in a CS. Each participant shall have Zero or more
662 capabilities. A participant may use different capabilities
663 depending on the role it plays at a particular instance. IOW if a
664 participants moves across different CSs ( due to transfer e.t.c)
665 OR is simultaneously present in different CSs its role may be
666 different and hence the capability used.
667 o "send" or "recv" element in each participant is associating SDP
668 m-lines with the participant. send element indicates that
669 participant is sending the stream of media with the mentioned
670 media description. recv element indicates that participant is
671 receiving the stream and by default all participant will receive
672 the stream. recv element has relevance in case whisper call
673 scenario wherein few of the participant in the session receives
674 the stream and not others.
676 6.6.2. Linkages
678 The participantCS association class is linked to participant and CS
679 classes. There are no cardinalties for this linkage.
681 6.6.3. XML element
683 participantsessionassoc XML element represent participantCS
684 association object. participant and session id is used to uniquely
685 identify this element
687 NOTE: RFC 4235 encoding shall be used to represent capabilities
688 attribute in XML.
690 6.7. Media Stream
692 Participant
693 | 0..* 1..*|
694 receives| |sends
695 | 0..* 0..*|
696 +-------------------------+
697 | Media Stream |
698 | |
699 Communication 0..1 0..* +-------------------------+
700 Session ------------| |
701 | Media Stream Reference |
702 | Content-type |
703 | |
704 +-------------------------+
706 A Media Stream class (and its objects) has the properties of media as
707 seen by SRC and sent to SRS. Different snapshots of media stream
708 object may be sent whenever there is a change in media (e.g. dir
709 change like pause/resume and/or codec change and/or participant
710 change.).
712 6.7.1. Attributes
714 A Media Stream class has the the following attributes:
716 o Media Stream Reference - In implementations this can reference to
717 m-line
718 o Content - The content of an MS element will be described in terms
719 of value from the [RFC4796] registry.
721 The metadata model should include media streams that are not being
722 delivered to the SRS. Examples include cases where SRC offered
723 certain media types but SRS chooses to accept only a subset of them
724 OR an SRC may not even offer a certain media type due it its
725 restrictions to record
727 6.7.2. Linkages
729 A Media Stream is linked to participant and CS classes using the
730 association relationship. The details of association with the
731 Participant are described in the Participant class section. The
732 details of association with CS is mentioned in the CS section.
734 6.7.3. XML element
736 stream element represents a Media Stream object. Stream element
737 indicates SDP media lines associated with the session and
738 participants.
740 This element indicates the SDP m-line properties like label
741 attributes. Label attribute is used to link m-line SDP body using
742 label attribute in SDP m-line.
744 Each stream element has unique Base 64 URN UUID attribute which helps
745 to uniquely identify stream and session Base 64 URN UUID to associate
746 stream with specific session element.
748 The content attribute if an SRC wishes to send is conveyed in RS SDP.
750 6.8. ParticipantStream Association
751 +-------------------+
752 | ParticipantSteam |
753 | Association |
754 +-------------------+ +----------Participant
755 | Association-Time | | 0..*| 1..*|
756 | Disassociaton-Time|---+ recv| |sends
757 | Recv | | 0..*| 0..*|
758 | Send | | | |
759 +-------------------+ | | |
760 +----------Media Stream
762 A ParticipantStream association class and its object has attributes
763 that are attributes of association of a Participant to a Stream.
765 6.8.1. Attributes
767 A participantStream association class has the following attributes:
769 o Associate-Time: This attributes indicates the time a Participant
770 started contributing to a Media Stream
771 o Disassociate-Time: This attribute indicates the time a Participant
772 stopped contributing to a Media Stream
774 6.8.2. Linkages
776 The participantStream association class is linked to participant and
777 Stream classes. There are no cardinalties for this linkage.
779 6.8.3. XML element
781 ParticipantStreamAssoc XML element represents participant to stream
782 association object. participant element is used to uniquely identify
783 this element and related with stream using stream unique URN id..
785 6.9. associate-time/disassociate-time
787 associate-time/disassociate-time contains a string indicating the
788 date and time of the status change of this tuple. The value of this
789 element MUST follow the IMPP datetime format [RFC3339]. Timestamps
790 that contain 'T' or 'Z' MUST use the capitalized forms. At a time,
791 any of the time tuple associate-time or disassociate-time MAY exist
792 in the element namely group, session, participant and not both
793 timestamp at the same time.
795 As a security measure, the timestamp element SHOULD be included in
796 all tuples unless the exact time of the status change cannot be
797 determined.
799 6.10. Unique ID format
801 Unique id is generated in two steps:
802 o UUID is created using [RFC4122])
803 o UUID is encoded using base64 as defined in [RFC4648]
805 The above mentioned unique-id mechanism SHOULD be used for each
806 metadata element.
808 7. SIP Recording Metadata Example
810 7.1. Complete SIP Recording Metadata Example
812 The following example provides all the tuples involved in Recording
813 Metadata XML body.
815
816
817 complete
818
819 2010-12-16T23:41:07Z
820
821
822 sip:alice@atlanta.com
823 FaXHlc+3WruaroDaNE87am==
824
825
826 FOO!
827 bar
828
829
830
831 7+OTCyoxTmqmqyA/1weDAg==
832
834
835 FOO!
836 bar
837
838
839 2010-12-16T23:41:07Z
840
841
843
844 Bob B
845
846
847 FOO!
848 bar
849
850
853 2010-12-16T23:41:07Z
854
855
857 i1Pz3to5hGk8fuXl+PbwCw==
858 UAAMm5GRQKSCMVvLyl4rFw==
859 8zc6e0lYTlWIINA6GR+3ag==
860 EiXGlc+4TruqqoDaNE76ag==
861
862
864
865 Paul
866
867
868 FOO!
869 bar
870
871
874 2010-12-16T23:41:07Z
875
876
878 8zc6e0lYTlWIINA6GR+3ag==
879 EiXGlc+4TruqqoDaNE76ag==
880 UAAMm5GRQKSCMVvLyl4rFw==
881 i1Pz3to5hGk8fuXl+PbwCw==
882
883
885
886
887
889
890
891
893
894
895
897
898
899
901 SIP Recording Metadata Example XML body
903 7.2. Partial Update of Recording metadata XML body
905 The following example provides partial update in Recording Metadata
906 XML body for the above example. The example has a snapshot that
907 carries the disassociate-time for a participant from a session.
909
910
911 partial
912
914
915 Bob R
916
917 FOO!
918 bar
919
920
923 2010-12-16T23:41:07Z
924
925
927 Partial update of SIP Recording Example XML body
929 8. XML Schema definition for Recording metadata
931 This section defines XML schema for Recording metadata document
933
934
939
940
941
942
943
944
946
948
950
952
954
958
959
960
961
962
964
966
970
971
973
974
975
976
978
980
984
985
987
988
989
990
992
994
998
999
1001
1002
1003
1004
1006
1010
1011
1013
1014
1015
1016
1018
1020
1024
1025
1027
1029
1030
1031
1032
1034
1036
1038
1040
1044
1045
1047
1048
1049
1050
1052
1056
1057
1059
1060
1061
1062
1063
1064
1065
1066
1068
1069
1070
1071
1072
1073
1075
1076
1077
1078
1079
1080
1081
1083
1085 9. Security Considerations
1087 The metadata information sent from SRC to SRS MAY reveal sensitive
1088 information about different participants in a session. For this
1089 reason, it is RECOMMENDED that a SRC use a strong means for
1090 authentication and metadata information protection and that it apply
1091 comprehensive authorization rules when using the metadata format
1092 defined in this document. The following sections will discuss each
1093 of these aspects in more detail.
1095 9.1. Connection Security
1097 It is RECOMMENDED that a SRC authenticate SRS using the normal SIP
1098 authentication mechanisms, such as Digest as defined in Section 22 of
1099 [RFC3261]. The mechanism used for conveying the metadata information
1100 MUST ensure integrity and SHOULD ensure confidentially of the
1101 information. In order to achieve these, an end-to-end SIP encryption
1102 mechanism, such as S/MIME described in [RFC3261], SHOULD be used.
1104 If a strong end-to-end security means (such as above) is not
1105 available, it is RECOMMENDED that a SRC use mutual hop-by-hop
1106 Transport Layer Security (TLS) authentication and encryption
1107 mechanisms described in "SIPS URI Scheme" and "Interdomain Requests"
1108 of [RFC3261].
1110 10. IANA Considerations
1112 This specification registers a new XML namespace, and a new XML
1113 schema.
1115 10.1. SIP recording metadata Schema Registration
1117 URI: urn:ietf:params:xml:ns:recording
1119 Registrant Contact: IETF SIPREC working group, Ram mohan
1120 R(rmohanr@cisco.com)
1121 XML: the XML schema to be registered is contained in Section 6.
1123 Its first line is and its last
1124 line is
1126 11. Acknowledgement
1128 We wish to thank John Elwell(Siemens-Enterprise), Henry Lum(Alcatel-
1129 Lucent), Leon Portman(Nice), De Villers, Andrew Hutton(Siemens-
1130 Enterprise), Deepanshu Gautam(Huawei), Charles Eckel(Cisco), Muthu
1131 Arul(Cisco), Michael Benenson(Cisco), Hadriel Kaplan (ACME), Brian
1132 Rosen(Neustar), Scott Orton(Broadsoft), Ofir Roth for their valuable
1133 comments and inputs.
1135 We wish to thank Joe Hildebrand(Cisco), Peter Saint-Andre(Cisco) for
1136 the valuable XML related guidance and Martin Thompson for validating
1137 the XML schema and providing comments on the same.
1139 12. Appendix A: Metadata Model Object Instances
1141 Note: This Appendix has to be moved to callflow document after the
1142 discussion in the mailing alias
1144 This section describes the metadata model object instances for
1145 different use cases of SIPREC. For the sake of simplicity as the
1146 media streams sent by each of the participants is received by every
1147 other participant in these use cases, it is NOT shown in the object
1148 instance diagrams below. Also for the sake of ease not all
1149 attributes of each object are shown in these instance diagrams.
1151 12.1. Use case 1: Basic Call
1153 Basic call between two Participants A and B. In this use case each
1154 participant sends one Media Stream. For the sake of simplicity
1155 "receives" lines are not shown in this instance diagram. Media
1156 Streams sent by each participant is received all other participants
1157 of that CS.
1159 +-------------------------------+
1160 | Recording Session (RS) |
1161 +-------------------------------+
1162 |
1163 |
1164 |
1165 +----------------+
1166 | Communication |
1167 | Session (CS) |
1168 +----------------+-----------------------+
1169 | Start Time | |
1170 +----------------+ |
1171 | |
1172 |-------------------+ |
1173 | | |
1174 +---------------+ +---------------+ |
1175 | ParticipantA | | ParticipantB | |
1176 | | | | |
1177 +---------------+ +---------------+ |
1178 | | |
1179 sends | | sends |
1180 | | |
1181 +---------------+ +---------------+ |
1182 |Media Stream A1| |Media Stream B1| |
1183 +---------------+ +---------------+ |
1184 |MediaStream Ref| |MediaStream Ref| |
1185 | | | | |
1186 +---------------+ +---------------+ |
1187 | | |
1188 +-----------------------------------+
1190 12.2. Use case 2: Hold/Resume
1192 Basic call between two Participants A and B and with Participant A or
1193 B doing a Hold/Resume. In this use case each participant sends one
1194 Media Stream. After Hold/Resume the properties of Media can change.
1195 For the sake of simplicity "receives" lines are not shown in this
1196 instance diagram. Media Streams sent by each participant is received
1197 all other participants of that CS.
1199 +-------------------------------+
1200 | Recording Session (RS) |
1201 +-------------------------------+
1202 | |
1203 | |
1204 | |
1205 | +-------------------------------+
1206 | | Communication Session (CS) |
1207 | +-----------| Group(CSG) |
1208 | | +-------------------------------+
1209 | | | Unique-id1 |
1210 | | +-------------------------------+
1211 | |
1212 | |
1213 | |
1214 +----------------+
1215 | Communication |
1216 +-| Session (CS) |----------------------------------------------+
1217 | +----------------+ |
1218 | | | |
1219 | +----------------+ |
1220 | | |
1221 | |-------------------+ |
1222 | | | |
1223 | +---------------+ +---------------+ |
1224 | | ParticipantA | | ParticipantB |-----------+ |
1225 | | |--+ | | | |
1226 | +---------------+ | +---------------+ |sends(After |
1227 | | | | | | | Resume) |
1228 | | | | | | +--------------+ |
1229 | sends | | +--+ | sends | |MediaStream B3| |
1230 | | -----+ | | +-----+ +--------------+ |
1231 | +---------------+ | | +---------------+ | |MediaStreamRef|-|
1232 | |Media Stream A1| | | |Media Stream B1| | | | |
1233 | +---------------+ | | +---------------+ | | | |
1234 +-|MediaStreamref | | | |MediaStreamRef | | +--------------+ |
1235 | | | | | |-|-------------------|
1236 +---------------+ | | +---------------+ | |
1237 | | | |
1238 +------------+ |sends |sends (hold) |
1239 | sends |(Resume) | |
1240 | (hold) +-------+ +-------+ |
1241 | | | |
1242 +---------------+ +---------------+ +--------------+ |
1243 |Media Stream A2| |Media Stream A3| |MediaStream B2| |
1244 +---------------+ +---------------+ | | |
1245 |MediaStreamref | |MediaStreamRef | +--------------+ |
1246 | | | | |Codec Params | |
1247 +---------------+ +---------------+ | | |
1248 | | | | |
1249 | | +--------------+ |
1250 | | | |
1251 +------------------------------------------------------+
1253 12.3. Use case 3: Basic call with Transfer
1255 Basic call between two Participants A and B and with Participant A
1256 transfer(consult transfer) to Participant C. In this use case each
1257 participant sends one Media Stream. After transfer the properties of
1258 Participant A Media can change. For the sake of simplicity
1259 "receives" lines are not shown in this instance diagram. Media
1260 Streams sent by each participant is received all other participants
1261 of that CS.
1263 +-------------------------------+
1264 | Recording Session (RS) |-------+
1265 +-------------------------------+ |
1266 | |
1267 | |
1268 | |
1269 +-------------------------------+ |
1270 | Communication Session (CS) | |
1271 | Group(CSG) | |
1272 +-------------------------------+ |
1273 | Unique-id1 | |
1274 +-------------------------------+ |
1275 | |
1276 |----------------------------+
1277 |
1278 |-----------------+
1279 | |
1280 +----------------+ +----------------+
1281 | Communication | | Communication |
1282 | Session (CS)1 | | Session (CS)2 |
1283 +----------------+ +----------------+-----------+
1284 | | | | |
1285 +----------------+ +----------------+ |
1286 | |
1287 |-------------------+ |
1288 | | | |
1289 +---------------+ | +---------------+ |
1290 | ParticipantA | | | ParticipantB | |
1291 | | | | | |
1292 +---------------+ | +---------------+ |
1293 | | | |
1294 sends | | | sends |
1295 | | | |
1296 +---------------+ | +---------------+ |
1297 |Media Stream A1| | |Media Stream B1| |
1298 +---------------+ | +---------------+ |
1299 | | | | | |
1300 | | | | Media Stream | |
1301 | Media Stream |---+---| Ref | |
1302 | Ref | | | |
1303 +---------------+ +---------------+ |
1304 |
1305 |
1306 +----------------------------|
1307 | |
1308 +--------------------------------+ |
1309 | | |
1310 +---------------+ +---------------+ |
1311 | Participant A | | Participant C | |
1312 | (same) | | | |
1313 +---------------+ +---------------+ |
1314 | | |
1315 | sends (After transfer) | sends |
1316 +----------------+ +----------------+|
1317 | Media Stream A2| | Media Stream C1||
1318 +----------------+ +----------------+|
1319 | Media StreamRef| | Media StreamRef||
1320 | | | ||
1321 | | | ||
1322 +----------------+ +----------------+|
1323 | | |
1324 | | |
1325 | | |
1326 +-------------------------------------------+
1328 12.4. Conference Use Cases
1330 Depending on who act as SRC and the information that an SRC has there
1331 can be several ways to model conference use cases. This section has
1332 instance diagrams for the following cases:
1334 o A CS where one of the participant (which is also SRC) is a user in
1335 a conference
1336 o A CS where one of the participant is focus ( which is also SRC)
1337 o A CS where one of the participant is user and the SRC is a
1338 different entity like B2BUA
1339 o A CS where one of the participant is focus and the SRC is a
1340 different entity like B2BUA
1342 NOTE: There MAY be other ways to model the same use cases depending
1343 on what information the SRC has.
1345 12.4.1. Case 1:
1347 This is the usecase where there is a CS with one of the participant
1348 (who is also SRC) as a user in a conference. For the sake of
1349 simplicity the receive lines for each of the participant is not
1350 shown.
1352 +---------------------------------------------------+
1353 | Communication Session |
1354 | +-------------+ +--------------+ |
1355 | | | | | |
1356 | |Participant B| | Participant A| |
1357 | | (User in |--------------| | |
1358 | | conf/SRC) | | | |
1359 | +-------------+ +--------------+ |
1360 | | | | | |
1361 +---------------------------------------------------+
1362 | | | |
1363 | | | |
1364 D E F G (Participants of Conference)
1366 Instance Diagram:
1368 +-------------------------------+
1369 | Recording Session (RS) |--+
1370 +-------------------------------+ |
1371 | |
1372 | |
1373 | |
1374 +-------------------------------+ |
1375 | Communication Session (CS) | |
1376 | Group(CSG) | |
1377 +-------------------------------+ |
1378 | Unique-id1 | |
1379 +-------------------------------+ |
1380 | |
1381 |-----------------------+
1382 |
1383 +----------------+
1384 | Communication |
1385 | Session (CS) |--+----------------+-----+
1386 +----------------+ | | |
1387 | | | | |
1388 +----------------+ | | |
1389 | | | |
1390 | | | |
1391 | | | |
1392 +---------------+ | | |
1393 | ParticipantA | | | |
1394 | | | | |
1395 +---------------+ | | |
1396 | | | |
1397 sends | | | |
1398 | | | |
1399 +---------------+ | | |
1400 |Media Stream A1| | | |
1401 +---------------+ | | |
1402 |MediaStream Ref|-----|----------------+ |
1403 | | | | |
1404 +---------------+ | | |
1405 | | |
1406 | | |
1407 +-------------+ | |
1408 | | |
1409 | | |
1410 +----------------+ | |
1411 | Participant B | | |
1412 | (in conf) | | |
1413 +----------------+ | |
1414 | | |
1415 sends | | |
1416 | | |
1417 +----------------+ | |
1418 | Media Stream B1|---------------------+ |
1419 +----------------+ sends |
1420 | MediaStream Ref| |
1421 | | +-----------------+
1422 +----------------+ |
1423 | |
1424 |sends |
1425 | |
1426 +-----------------+-------------+------------+
1427 | | | |
1428 | | | |
1429 +------------+ +------------+ +------------+ +-------------+
1430 |participantD| |ParticipantE| |ParticipantF| |Participant G|
1431 +------------+ +------------+ +------------+ +-------------+
1433 In this example we have two participants A and B who are part of a
1434 Communication Session(CS). One of the participants B is part of a
1435 conference and also acts as SRC.There can be two cases here. B can
1436 be a participant of the conference or B can be a focus. In this
1437 instance diagram Participant B is a user in a conference. The SRC
1438 (Participant B) subscribes to conference event package to get the
1439 details of other particiants. Participant B(SRC) sends the same
1440 through the metadata to SRS. In this instance diagram the Media
1441 Stream(mixed stream) sent from Participant B has media streams
1442 contributed by conference participants (D,E,F and G). For the sake
1443 of simplicity the "receives" line is not shown here. In this example
1444 the media stream sent by each participant(A or B) of CS is received
1445 by all other participant(A or B).
1447 12.4.2. Case 2:
1449 This is the usecase where there is a CS where one of the participant
1450 is focus ( which is also SRC).
1452 +---------------------------------------------------+
1453 | Communication Session |
1454 | +--------------+ +--------------+ |
1455 | | |--------------| | |
1456 | |Participant C | | Participant A| |
1457 | | (Focus in |------+ | | |
1458 | | conf and SRC)|---+ | +--------------+ |
1459 | +--------------+ | | |
1460 | | | +---------+ |
1461 | | | | |
1462 | +--------------+ | +---------------+ |
1463 | | Participant B| +---+ | Participant D | |
1464 | | | | | | |
1465 | +--------------+ | +---------------+ |
1466 | | |
1467 | +--------------+ |
1468 | |Participant E | |
1469 | | | |
1470 | +--------------+ |
1471 | |
1472 +---------------------------------------------------+
1474 Instance Diagram:
1476 +-------------------------------+
1477 | Recording Session (RS) |
1478 +-------------------------------+
1479 |-------------------------+
1480 | |
1481 | |
1482 +-------------------------------+ |
1483 | Communication Session (CS) | |
1484 | Group(CSG) | |
1485 +-------------------------------+ |
1486 | Unique-id1 | |
1487 +-------------------------------+ |
1488 | |
1489 |-------------------------+
1490 |
1491 +----------------+
1492 | Communication |
1493 | Session (CS) |----------------------+
1494 +----------------+ |
1495 | | |
1496 +----------------+ |
1497 | |
1498 |-------------------+ |
1499 | | | |
1500 +---------------+ | +---------------+ |
1501 | ParticipantA | | | ParticipantB | |
1502 | | | | | |
1503 +---------------+ | +---------------+ |
1504 | | | |
1505 sends | | | sends |
1506 | | | |
1507 +---------------+ | +---------------+ |
1508 |Media Stream A1| | |Media Stream B1| |
1509 +---------------+ | +---------------+ |
1510 |MediaStream Ref| | |MediaStream Ref| |
1511 | |---+---| | |
1512 +---------------+ +---------------+ |
1513 |
1514 +----------------------------------+
1515 | | | |
1516 | | | |
1517 +---------------+ | +---------------+ |
1518 | ParticipantD | | | ParticipantE | |
1519 | | | | | |
1520 +---------------+ | +---------------+ |
1521 | | | |
1522 sends | | | sends |
1523 | | | |
1524 +---------------+ | +---------------+ |
1525 |Media Stream D1| | |Media Stream E1| |
1526 +---------------+ | +---------------+ |
1527 |MediaStream Ref| | |MediaStream Ref| |
1528 | |---+---| | |
1529 +---------------+ +---------------+ |
1530 |
1531 |
1532 +----------+
1533 +-----------------|
1534 | |
1535 | |
1536 +----------------+ |
1537 | Participant C | |
1538 | (focus +src) | |
1539 +----------------+ |
1540 | |
1541 Sends | +-------+
1542 | |
1543 "sends" OR | |
1544 contributed +----------------+
1545 by | Media Stream C1|
1546 Participants+----------------+ "receives" by participants A,B,D,E
1547 A,B,D,E | MediaStream Ref|------------------------------------
1548 ------------| Codec Params |
1549 +----------------+
1551 In this example we have two participants A and B who are part of a
1552 Communication Session(CS). One of the participants (C) is focus of a
1553 conference and also acts as SRC. The SRC (Participant C) being the
1554 Focus of the conference has access to the details of other
1555 particiants. SRC (Participant C) sends the same through the metadata
1556 to SRS. In this instance diagram the Media Stream(mixed stream) sent
1557 by C has media streams contributed by conference participants (A, B,
1558 D and E). Participants A, B,D and E sends Media Streams A1, B1, D1
1559 and E1 respectively. The media stream sent by Participant C(Focus)
1560 is received by all other participants of CS. For the sake of
1561 simplicity the "receives" line is not shown linked to all other
1562 participants.
1564 NOTE: SRC ( Participant C) can send mixed stream or seperate streams
1565 to SRS
1567 12.4.3. Case 3:
1569 A CS where one of the participant is user and the SRC is a different
1570 entity like B2BUA. In this case the SRC may not know that one of the
1571 user is part of conference. Hence the instance diagram will not have
1572 information about the conference participants.
1574 +---------------------------------------------------+
1575 | Communication Session |
1576 | +-------------+ +------+ +--------------+ |
1577 | | | | (SRC)| | | |
1578 | |Participant B|--|B2BUA |----| Participant A| |
1579 | | (User in | +------+ | | |
1580 | | conf) | | | |
1581 | +-------------+ +--------------+ |
1582 | | | | | |
1583 +---------------------------------------------------+
1584 | | | |
1585 | | | |
1586 D E F G (Participants of Conference)
1588 12.4.4. Case 4:
1590 A CS where one of the participant is focus and the SRC is a different
1591 entity like B2BUA. In this case the participant which is focus sends
1592 "isfocus" in SIP message to SRC. The SRC subscribe to conference
1593 event package on seeing this "isfocus". SRC learns the details of
1594 other participants of conference from the conference package and send
1595 the same in metadata to SRS. The instance diagram for this use case
1596 is same as Case 1.
1598 +--------------------------------+
1599 | Conference Event Package |
1600 | |
1601 +--------------------------------+
1602 |
1603 | subscribes
1604 |
1605 +---------------------|-----------------------------+
1606 | Communication |Session |
1607 | +-------------+ +------+ +--------------+ |
1608 | | | | (SRC)| | | |
1609 | |Participant B|--|B2BUA |----| Participant A| |
1610 | | (FOCUS in | +------+ | | |
1611 | | conf) | | | |
1612 | +-------------+ +--------------+ |
1613 | | | | | |
1614 +---------------------------------------------------+
1615 | | | |
1616 | | | |
1617 D E F G (Participants of Conference)
1619 13. Appendix B: Metadata XML schema Instances
1621 Note: This Appendix has to be moved to callflow document after the
1622 discussion in the mailing alias
1624 This section describes the metadata model XML instances for different
1625 use cases of SIPREC. For the sake of simplicity the complete SIP
1626 messages are NOT shown here.
1628 13.1. Use case 1: Basic Call
1630 Basic call between two Participants A(Alice) and B(Bob) who are part
1631 of one session. In this use case each participant sends two Media
1632 Streams. Media Streams sent by each participant is received all
1633 other participants of that CS in this use-case. Below is the initial
1634 snapshot sent by SRC that has complete metadata. For the sake of
1635 completeness even snippets of SDP is shown. For the sake of
1636 simplicity these use-cases assume the RS stream is unmixed.
1638 Content-Type: application/SDP
1639 ...
1640 m=audio 49170 RTP/AVP 0
1641 a=rtpmap:0 PCMU/8000
1642 a=label:96
1643 a=sendonly
1644 ...
1645 m=video 49174 RTP/AVPF 96
1646 a=rtpmap:96 H.264/90000
1647 a=label:97
1648 a=sendonly
1649 ...
1650 m=audio 51372 RTP/AVP 0
1651 a=rtpmap:0 PCMU/8000
1652 a=label:98
1653 a=sendonly
1654 ...
1655 m=video 49176 RTP/AVPF 96
1656 a=rtpmap:96 H.264/90000
1657 a=label:99
1658 a=sendonly
1659 ....
1660
1661
1662 complete
1663
1664 2010-12-16T23:41:07Z
1665
1666
1667 sip:alice@cisco.com
1668
1669
1670 FOO!
1671 bar
1672
1673
1674
1675 7+OTCyoxTmqmqyA/1weDAg==
1676
1677 2010-12-16T23:41:07Z
1678
1679 FOO!
1680 bar
1681
1682
1684
1685 Alice
1686
1687
1688 FOO!
1689 bar
1690
1691
1694 2010-12-16T23:41:07Z
1695
1696
1698 i1Pz3to5hGk8fuXl+PbwCw==
1699 UAAMm5GRQKSCMVvLyl4rFw==
1700 8zc6e0lYTlWIINA6GR+3ag==
1701 EiXGlc+4TruqqoDaNE76ag==
1702
1703
1705
1706 Bob
1707
1708
1709 FOO!
1710 bar
1711
1712
1715 2010-12-16T23:41:07Z
1716
1717
1719 8zc6e0lYTlWIINA6GR+3ag==
1720 EiXGlc+4TruqqoDaNE76ag==
1721 UAAMm5GRQKSCMVvLyl4rFw==
1722 i1Pz3to5hGk8fuXl+PbwCw==
1723
1724
1726
1727
1728
1730
1731
1732
1734
1735
1736
1738
1739
1740
1742 13.2. Use case 2: Hold/resume
1744 Basic call between two Participants A and B. This is the continuation
1745 of above use-case. One of the participants(say A) goes on hold and
1746 then resumes as part of the same session. The metadata snapshot
1747 looks as below
1749 During hold
1750 Content-Type: application/SDP
1751 ...
1752 m=audio 49170 RTP/AVP 0
1753 a=rtpmap:0 PCMU/8000
1754 a=label:96
1755 a=inactive
1756 ...
1757 m=video 49174 RTP/AVPF 96
1758 a=rtpmap:96 H.264/90000
1759 a=label:97
1760 a=inactive
1761 ...
1762 m=audio 51372 RTP/AVP 0
1763 a=rtpmap:0 PCMU/8000
1764 a=label:98
1765 a=sendonly
1766 ...
1767 m=video 49176 RTP/AVPF 96
1768 a=rtpmap:96 H.264/90000
1769 a=label:99
1770 a=sendonly
1771 ....
1773
1774
1775 partial
1776
1779 8zc6e0lYTlWIINA6GR+3ag==
1780 EiXGlc+4TruqqoDaNE76ag==
1781
1782
1785 8zc6e0lYTlWIINA6GR+3ag==
1786 EiXGlc+4TruqqoDaNE76ag==
1787
1789
1791 During resume
1793 The snapshot will look pretty much same as Use-case 1.
1795 13.3. Use case 3: Basic Call with transfer
1797 Basic call between two Participants A and B is connected as in Use-
1798 case 1. Transfer is initiated by one of the participants of by other
1799 entity(3PCC case). SRC sends a snapshot of the participant changes
1800 to SRS. In this instance participant A(Alice) drops out during the
1801 transfer and Participant C(Paul) joins the session. There can be two
1802 cases here, same session continues after transfer or a new session
1803 (e.g. REFER based transfer) is created
1805 Transfer with same session retained - (.e.g. RE-INVITE based
1806 transfer). Participant A drops out and C is added to the same
1807 session. No change to session/group element. C will be new stream
1808 element which maps to RS SDP using the same labels in this instance.
1810 Content-Type: application/SDP
1811 ...
1812 m=audio 49170 RTP/AVP 0
1813 a=rtpmap:0 PCMU/8000
1814 a=label:96
1815 a=sendonly
1816 ...
1817 m=video 49174 RTP/AVPF 96
1818 a=rtpmap:96 H.264/90000
1819 a=label:97
1820 a=sendonly
1821 ...
1822 m=audio 51372 RTP/AVP 0
1823 a=rtpmap:0 PCMU/8000
1824 a=label:98
1825 a=sendonly
1826 ...
1827 m=video 49176 RTP/AVPF 96
1828 a=rtpmap:96 H.264/90000
1829 a=label:99
1830 a=sendonly
1831 ....
1832
1833
1834 partial
1835
1837 8zc6e0lYTlWIINA6GR+3ag==
1838 EiXGlc+4TruqqoDaNE76ag==
1839 60JAJm9UTvik0Ltlih/Gzw==
1840 AcR5FUd3Edi8cACQJy/3JQ==
1841
1842
1844
1845 Paul
1846
1847
1848 FOO!
1849 bar
1850
1851
1854 2010-12-16T23:41:07Z
1855
1856
1858 60JAJm9UTvik0Ltlih/Gzw==
1859 AcR5FUd3Edi8cACQJy/3JQ==
1860 8zc6e0lYTlWIINA6GR+3ag==
1861 EiXGlc+4TruqqoDaNE76ag==
1862
1863
1865
1866
1867
1869
1870
1871
1873
1874
1875
1877
1878
1879
1881 Transfer with new session - (.e.g. REFER based transfer). In this
1882 case new session is part of same grouping (done by SRC).
1884 SRC may send an optional snapshot indicating stop for the old
1885 session.
1887
1888
1889 Partial
1890
1891 7+OTCyoxTmqmqyA/1weDAg==
1892
1893 2010-12-16T23:41:07Z
1894
1895 FOO!
1896 bar
1897
1898
1901 2010-12-16T23:41:07Z
1902
1903
1906 2010-12-16T23:41:07Z
1907
1908
1910 SRC sends a snapshot to indicate the participant change and new
1911 session information after transfer. In this example the same RS is
1912 used.
1914 Content-Type: application/SDP
1915 ...
1916 m=audio 49170 RTP/AVP 0
1917 a=rtpmap:0 PCMU/8000
1918 a=label:96
1919 a=sendonly
1920 ...
1921 m=video 49174 RTP/AVPF 96
1922 a=rtpmap:96 H.264/90000
1923 a=label:97
1924 a=sendonly
1925 ...
1926 m=audio 51372 RTP/AVP 0
1927 a=rtpmap:0 PCMU/8000
1928 a=label:98
1929 a=sendonly
1930 ...
1931 m=video 49176 RTP/AVPF 96
1932 a=rtpmap:96 H.264/90000
1933 a=label:99
1934 a=sendonly
1935 ....
1936
1937
1938 partial
1939
1940 7+OTCyoxTmqmqyA/1weDAg==
1941
1942 2010-12-16T23:41:07Z
1943
1944 FOO!
1945 bar
1946
1947
1949
1950
1951 FOO!
1952 bar
1953
1954
1957 2010-12-16T23:32:03Z
1958
1959
1961 8zc6e0lYTlWIINA6GR+3ag==
1962 EiXGlc+4TruqqoDaNE76ag==
1963 60JAJm9UTvik0Ltlih/Gzw==
1964 AcR5FUd3Edi8cACQJy/3JQ==
1965
1966
1968
1969
1970 FOO!
1971 bar
1972
1973
1976 2010-12-16T23:41:07Z
1977
1978
1980 60JAJm9UTvik0Ltlih/Gzw==
1981 AcR5FUd3Edi8cACQJy/3JQ==
1982 8zc6e0lYTlWIINA6GR+3ag==
1983 EiXGlc+4TruqqoDaNE76ag==
1984
1985
1987
1988
1989
1991
1992
1993
1995
1996
1997
1999
2000
2001
2003 13.4. Use Case 4: Call disconnect
2005 This example shows a snapshot of metadata sent by an SRC at CS
2006 disconnect where the participants of CS are Alice and Bob
2007
2008
2009 Partial
2010
2011 7+OTCyoxTmqmqyA/1weDAg==
2012
2013 2010-12-16T23:41:07Z
2014
2015 FOO!
2016 bar
2017
2018
2020
2021 2010-12-16T23:41:07Z
2022
2024
2026
2027 2010-12-16T23:41:07Z
2028
2029
2031 14. References
2033 14.1. Normative References
2035 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
2036 Requirement Levels", BCP 14, RFC 2119, March 1997.
2038 [RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997.
2040 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
2041 A., Peterson, J., Sparks, R., Handley, M., and E.
2042 Schooler, "SIP: Session Initiation Protocol", RFC 3261,
2043 June 2002.
2045 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
2046 January 2004.
2048 [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the
2049 Internet: Timestamps", RFC 3339, July 2002.
2051 [RFC4566] Handley, M., Jacobson, V., and C. Perkins, "SDP: Session
2052 Description Protocol", RFC 4566, July 2006.
2054 [RFC4574] Levin, O. and G. Camarillo, "The Session Description
2055 Protocol (SDP) Label Attribute", RFC 4574, August 2006.
2057 [RFC4796] Hautakorpi, J. and G. Camarillo, "The Session Description
2058 Protocol (SDP) Content Attribute", RFC 4796,
2059 February 2007.
2061 [RFC3840] Rosenberg, J., Schulzrinne, H., and P. Kyzivat,
2062 "Indicating User Agent Capabilities in the Session
2063 Initiation Protocol (SIP)", RFC 3840, August 2004.
2065 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
2066 Unique IDentifier (UUID) URN Namespace", RFC 4122,
2067 July 2005.
2069 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data
2070 Encodings", RFC 4648, October 2006.
2072 14.2. Informative References
2074 [RFC6341] Rehor, K., Portman, L., Hutton, A., and R. Jain, "Use
2075 Cases and Requirements for SIP-Based Media Recording
2076 (SIPREC)", RFC 6341, August 2011.
2078 [I-D.ietf-siprec-architecture]
2079 Hutton, A., Portman, L., Jain, R., and K. Rehor, "An
2080 Architecture for Media Recording using the Session
2081 Initiation Protocol", draft-ietf-siprec-architecture-06
2082 (work in progress), September 2012.
2084 [RFC2648] Moats, R., "A URN Namespace for IETF Documents", RFC 2648,
2085 August 1999.
2087 [RFC3326] Schulzrinne, H., Oran, D., and G. Camarillo, "The Reason
2088 Header Field for the Session Initiation Protocol (SIP)",
2089 RFC 3326, December 2002.
2091 [RFC3325] Jennings, C., Peterson, J., and M. Watson, "Private
2092 Extensions to the Session Initiation Protocol (SIP) for
2093 Asserted Identity within Trusted Networks", RFC 3325,
2094 November 2002.
2096 Authors' Addresses
2098 Ram Mohan Ravindranath
2099 Cisco Systems, Inc.
2100 Cessna Business Park,
2101 Kadabeesanahalli Village, Varthur Hobli,
2102 Sarjapur-Marathahalli Outer Ring Road
2103 Bangalore, Karnataka 560103
2104 India
2106 Email: rmohanr@cisco.com
2108 Parthasarathi Ravindran
2109 Nokia Siemens Networks
2110 Bangalore, Karnataka
2111 India
2113 Email: partha@parthasarathi.co.in
2115 Paul Kyzivat
2116 Huawei
2117 Hudson, MA
2118 USA
2120 Email: pkyzivat@alum.mit.edu