summaryrefslogtreecommitdiff
path: root/doc/rfc/rfc6035.txt
blob: 0a622c29f9e4032bd6318f25f8849df752f986f0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
Internet Engineering Task Force (IETF)                      A. Pendleton
Request for Comments: 6035                                      A. Clark
Category: Standards Track                          Telchemy Incorporated
ISSN: 2070-1721                                              A. Johnston
                                                                   Avaya
                                                            H. Sinnreich
                                                            Unaffiliated
                                                           November 2010


 Session Initiation Protocol Event Package for Voice Quality Reporting

Abstract

   This document defines a Session Initiation Protocol (SIP) event
   package that enables the collection and reporting of metrics that
   measure the quality for Voice over Internet Protocol (VoIP) sessions.
   Voice call quality information derived from RTP Control Protocol
   Extended Reports (RTCP-XR) and call information from SIP is conveyed
   from a User Agent (UA) in a session, known as a reporter, to a third
   party, known as a collector.  A registration for the application/ vq-
   rtcpxr media type is also included.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in Section 2 of RFC 5741.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   http://www.rfc-editor.org/info/rfc6035.















Pendleton, et al.            Standards Track                    [Page 1]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


Copyright Notice

   Copyright (c) 2010 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

   This document may contain material from IETF Documents or IETF
   Contributions published or made publicly available before November
   10, 2008.  The person(s) controlling the copyright in some of this
   material may not have granted the IETF Trust the right to allow
   modifications of such material outside the IETF Standards Process.
   Without obtaining an adequate license from the person(s) controlling
   the copyright in such materials, this document may not be modified
   outside the IETF Standards Process, and derivative works of it may
   not be created outside the IETF Standards Process, except to format
   it for publication as an RFC or to translate it into languages other
   than English.

























Pendleton, et al.            Standards Track                    [Page 2]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


Table of Contents

   1. Introduction ....................................................4
      1.1. Applicability Statement ....................................4
      1.2. Use of the Mechanism .......................................4
   2. Terminology .....................................................6
   3. SIP Events for VoIP Quality Reporting ...........................6
      3.1. SUBSCRIBE NOTIFY Method ....................................6
      3.2. PUBLISH Method .............................................7
      3.3. Multi-Party and Multi-Segment Calls ........................7
      3.4. Overload Avoidance .........................................7
   4. Event Package Formal Definition .................................8
      4.1. Event Package Name .........................................8
      4.2. Event Package Parameters ...................................8
      4.3. SUBSCRIBE Bodies ...........................................8
      4.4. Subscribe Duration .........................................8
      4.5. NOTIFY Bodies ..............................................8
      4.6. Voice Quality Event and Semantics .........................10
           4.6.1. ABNF Syntax Definition .............................10
           4.6.2. Parameter Definitions and Mappings .................21
      4.7. Message Flow and Syntax Examples ..........................29
           4.7.1. End of Session Report Using NOTIFY .................29
           4.7.2. Midsession Threshold Violation Using NOTIFY ........32
           4.7.3. End of Session Report Using PUBLISH ................35
           4.7.4. Alert Report Using PUBLISH .........................37
      4.8. Configuration Dataset for vq-rtcpxr Events ................39
   5. IANA Considerations ............................................39
      5.1. SIP Event Package Registration ............................39
      5.2. application/vq-rtcpxr Media Type Registration .............39
   6. Security Considerations ........................................40
   7. Contributors ...................................................40
   8. References .....................................................40
      8.1. Normative References ......................................40
      8.2. Informative References ....................................41

















Pendleton, et al.            Standards Track                    [Page 3]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


1.  Introduction

   Real-time communications over IP networks use SIP for signaling with
   RTP/RTCP for media transport and reporting, respectively.  These
   protocols are very flexible and can support an extremely wide
   spectrum of usage scenarios.  For this reason, extensions to these
   protocols must be specified in the context of a specific usage
   scenario.  In this memo, extensions to SIP are proposed to support
   the reporting of RTP Control Protocol Extended Reports [4] metrics.

1.1.  Applicability Statement

   RTP is utilized in many different architectures and topologies.  RFC
   5117 [13] lists and describes the following topologies: point-to-
   point, point-to-multipoint using multicast, point-to-multipoint using
   the translator from RFC 3550, point-to-multipoint using the mixer
   model from RFC 3550, point-to-multipoint using video-switching
   Multipoint Control Units (MCUs), point-to-multipoint using RTCP-
   terminating MCU, and non-symmetric mixer/translators.  As the
   Abstract of this document points out, this specification is for
   reporting quality of Voice over Internet Protocol (VoIP) sessions.
   As such, only the first topology, point to point, is currently
   supported by this specification.  This reflects both current VoIP
   deployments, which are predominantly point to point using unicast,
   and the state of research in the area of quality.

   How to accurately report the quality of a multipart conference or a
   session involving multiple hops through translators and mixers is
   currently an area of research in the industry.  However, this
   mechanism can easily be used for centrally mixed conference calls, in
   which each leg of the conferences is just a point-to-point call.
   This mechanism could be extended to cover additional RTP topologies
   in the future once these topics progress out of the realm of research
   and into actual Internet deployments.

1.2.  Use of the Mechanism

   RTCP reports are usually sent to other participating endpoints in a
   session.  This can make the collection of performance information by
   an administrator or management system quite complex to implement.  In
   the usage scenarios addressed in this memo, the data contained in
   RTCP XR VoIP metrics reports (RFC 3611 [4]) are forwarded to a
   central collection server systems using SIP.








Pendleton, et al.            Standards Track                    [Page 4]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   Applications residing in the server or elsewhere can aid in network
   management to alleviate bandwidth constraints and also to support
   customer service by identifying and acknowledging calls of poor
   quality.  However, specifying such applications is beyond the scope
   of this paper.

   There is a large portfolio of quality parameters that can be
   associated with VoIP, but only a minimal necessary number of
   parameters are included on the RTCP-XR reports:

   1.  The codec type, as resulting from the Session Description
       Protocol (SDP) offer-answer negotiation in SIP,

   2.  The burst gap loss density and max gap duration, since voice cut-
       outs are the most annoying quality impairment in VoIP,

   3.  Round-trip delay, because it is critical to conversational
       quality,

   4.  Conversational quality as a catch-all for other voice quality
       impairments, such as randomly distributed packet loss, jitter,
       annoying silent suppression effects, etc.

   In specific usage scenarios where other parameters are required,
   designers can include other parameters beyond the scope of this
   paper.

   RTCP reports are best effort only, and though they are very useful,
   they have a number of limitations as discussed in [3].  This must be
   considered when using RTCP reports in managed networks.

   This document defines a new SIP event package, vq-rtcpxr, and a new
   MIME type, application/vq-rtcpxr, that enable the collection and
   reporting of metrics that measure quality for RTP [3] sessions.  The
   definitions of the metrics used in the event package are based on
   RTCP Extended Reports [4] and RTCP [3]; a mapping between the SIP
   event parameters and the parameters within the aforementioned RFCs is
   defined within this document in Section 4.6.2.

   Monitoring of voice quality is believed to be the highest priority
   for usage of this mechanism, and as such, the metrics in the event
   package are largely tailored for voice quality measurements.  The
   event package is designed to be extensible.  However, the negotiation
   of such extensions is not defined in this document.

   The event package supports reporting the voice quality metrics for
   both the inbound and outbound directions.  Voice quality metrics for
   the inbound direction can generally be computed locally by the



Pendleton, et al.            Standards Track                    [Page 5]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   reporting endpoint; however, voice quality metrics for the outbound
   direction are computed by the remote endpoint and sent to the
   reporting endpoint using the RTCP Extended Reports [4].

   The configuration of the usage of this event package is not covered
   in this document.  It is the recommendation of this document that the
   SIP configuration framework [15] be used.  This is discussed in
   Section 4.8.

   The event package SHOULD be used with the SUBSCRIBE/NOTIFY method;
   however, it MAY also be used with the PUBLISH method [8] for backward
   compatibility with some existing implementations.  Message flow
   examples for both methods are provided in this document.

2.  Terminology

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in BCP 14, RFC 2119 [1].

3.  SIP Events for VoIP Quality Reporting

   This document defines a SIP events package [5] for Voice over IP
   performance reporting.  A SIP UA can send these events to an entity
   that can make the information available to other applications.  For
   purposes of illustration, the entities involved in SIP vq-rtcpxr
   event reporting will be referred to as follows:

   o  REPORTER: an entity involved in the measurement and reporting of
      media quality, i.e., the SIP UA involved in a media session.

   o  COLLECTOR: an entity that receives SIP vq-rtcpxr events.  A
      COLLECTOR may be a proxy server or another entity that is capable
      of supporting SIP vq-rtcpxr events.

3.1.  SUBSCRIBE NOTIFY Method

   The COLLECTOR SHALL send a SUBSCRIBE to the REPORTER to explicitly
   establish the relationship.  The REPORTER SHOULD send the voice
   quality metric reports using the NOTIFY method.  The REPORTER MUST
   NOT send any vq-rtcpxr events if a COLLECTOR address has not been
   configured.  The REPORTER populates the Request-URI according to the
   rules for an in-dialog request.  The COLLECTOR MAY send a SUBSCRIBE
   to a SIP Proxy acting on behalf of the reporting SIP UAs.







Pendleton, et al.            Standards Track                    [Page 6]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


3.2.  PUBLISH Method

   A SIP UA that supports this specification MAY also send the service
   quality metric reports using the PUBLISH method [8]; however, this
   approach SHOULD NOT be used, in general, on the public Internet.  The
   PUBLISH method MAY be supported for backward compatibility with
   existing implementations.

   The REPORTER MAY therefore populate the Request-URI of the PUBLISH
   method with the address of the COLLECTOR.  To ensure security of SIP
   proxies and the COLLECTOR, the REPORTER MUST be configured with the
   address of the COLLECTOR, preferably using the SIP UA configuration
   framework [15], as described in Section 5.8.

   It is RECOMMENDED that the REPORTER send an OPTIONS message to the
   COLLECTOR to ensure support of the PUBLISH message.

      If PUBLISH is not supported, then the REPORTER can only wait for a
      SUBSCRIBE request from the COLLECTOR and then deliver the
      information in NOTIFYs.  If a REPORTER sends a PUBLISH to a
      COLLECTOR that does not support or allow this method, a 501 Not
      Implemented or a 405 Method Not Allowed response will be received,
      and the REPORTER will stop publication.

3.3.  Multi-Party and Multi-Segment Calls

   A voice quality metric report may be sent for each session
   terminating at the REPORTER, and it may contain multiple report
   bodies.  For a multi-party call, the report MAY contain report bodies
   for the session between the reporting endpoint and each remote
   endpoint for which there was an RTP session during the call.

   Multi-party services such as call hold and call transfer can result
   in the user participating in a series of concatenated sessions,
   potentially with different choices of codec or sample rate, although
   these may be perceived by the user as a single call.  A REPORTER MAY
   send a voice quality metric report at the end of each session or MAY
   send a single voice quality metric report containing an application/
   vq-rtcpxr body for each segment of the call.

3.4.  Overload Avoidance

   Users of this extension should ensure that they implement general SIP
   mechanisms for avoiding overload.  For instance, an overloaded proxy
   or COLLECTOR MUST send a 503 Service Unavailable or other 5xx
   response with an appropriate Retry-After time specified.  REPORTERs
   MUST act on these responses and respect the Retry-After time




Pendleton, et al.            Standards Track                    [Page 7]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   interval.  In addition, future SIP extensions to better handle
   overload as covered in [14] should be followed as they are
   standardized.

   To avoid overload of SIP Proxies or COLLECTORS, it is important to do
   capacity planning and to minimize the number of reports that are
   sent.

   Approaches to avoiding overload include:

   a.  Send only one report at the end of each call.

   b.  Use interval reports only on "problem" calls that are being
       closely monitored.

   c.  Limit the number of alerts that can be sent to a maximum of one
       per call.

4.  Event Package Formal Definition

4.1.  Event Package Name

   This document defines a SIP Event Package.  SIP Event Packages were
   originally defined in RFC 3265 [5].

4.2.  Event Package Parameters

   No event package parameters are defined.

4.3.  SUBSCRIBE Bodies

   SUBSCRIBE bodies are described by this specification.

4.4.  Subscribe Duration

   Subscriptions to this event package MAY range from minutes to weeks.
   Subscriptions in hours or days are more typical and are RECOMMENDED.
   The default subscription duration for this event package is one hour.

4.5.  NOTIFY Bodies

   There are three notify bodies: a Session report, an Interval report,
   and an Alert report.

   The Session report SHOULD be used for reporting when a voice media
   session terminates, when a media change occurs, such as a codec
   change or a session fork, or when a session terminates due to no
   media packets being received and MUST NOT be used for reporting at



Pendleton, et al.            Standards Track                    [Page 8]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   arbitrary points in time.  This report MUST be used for cumulative
   metric reporting and the report timestamps MUST be from the start of
   a media session to the time at which the report is generated.

   The Interval report SHOULD be used for periodic or interval reporting
   and MUST NOT be used for reporting of the complete media session.
   This report is intended to capture short duration metric reporting
   and the report intervals SHOULD be non-overlapping time windows.

   The Alert report MAY be used when voice quality degrades during a
   session.  The time window to which an Alert report relates MAY be a
   short time interval or from the start of the call to the point the
   alert is generated; this time window SHOULD be selected to provide
   the most useful information to support problem diagnosis.

   Session, Interval, and Alert reports MUST populate the metrics with
   values that are measured over the interval explicitly defined by the
   "start" and "stop" timestamps.

   Voice quality summary reports reference only one codec (payload
   type).  This payload type SHOULD be the main voice payload, not
   comfort noise or telephone event payloads.  For applications that
   consistently and rapidly switch codecs, the most used codec should be
   reported.  All values in the report, such as IP addresses,
   synchronization source (SSRC), etc., represent those values as
   received by the REPORTER.  In some scenarios, these may not be the
   same on either end of the session -- the COLLECTOR will need logic to
   be able to put these sessions together.  The values of parameters
   such as sample rate, frame duration, frame octets, packets per
   second, round-trip delay, etc., depend on the type of report in which
   they are present.  If present in a Session or an Interval report,
   they represent average values over the session or interval.  If
   present in an Alert report, they represent instantaneous values.

   The REPORTER always includes local quality reporting information and
   should, if possible, share remote quality reporting information to
   the COLLECTOR.  This remote quality could be available from received
   RTCP-XR reports or other sources.  Reporting this is useful in cases
   where the other end might support RTCP-XR but not this voice quality
   reporting.

   This specification defines a new MIME type, application/vq-rtcpxr,
   which is a text encoding of the RTCP and RTCP-XR statistics with some
   additional metrics and correlation information.







Pendleton, et al.            Standards Track                    [Page 9]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.6.  Voice Quality Event and Semantics

   This section describes the syntax extensions required for event
   publication in SIP.  The formal syntax definitions described in this
   section are expressed in the Augmented BNF [6] format used in SIP [2]
   and contain references to elements defined therein.

   Additionally, the definition of the timestamp format is provided in
   [7].  Note that most of the parameters are optional.  In practice,
   most implementations will send a subset of the parameters.  It is not
   the intention of this document to define what parameters may or may
   not be useful for monitoring the quality of a voice session, but to
   enable reporting of voice quality.  As such, the syntax allows the
   implementer to choose which metrics are most appropriate for their
   solution.  As there are no "invalid", "unknown", or "not applicable"
   values in the syntax, the intention is to exclude any parameters for
   which values are not available, not applicable, or unknown.

   The authors recognize that implementers may need to add new parameter
   lines to the reports and new metrics to the existing parameter lines.
   The extension tokens are intended to fulfill this need.

4.6.1.  ABNF Syntax Definition

VQReportEvent  =  AlertReport /  SessionReport / IntervalReport

SessionReport = "VQSessionReport" [ HCOLON "CallTerm" ] CRLF
            SessionInfo  CRLF
            LocalMetrics [ CRLF RemoteMetrics ]
            [ CRLF DialogID ]

; CallTerm indicates the final report of a session.

IntervalReport = "VQIntervalReport" [ HCOLON "CallTerm" ] CRLF
            SessionInfo  CRLF
            LocalMetrics [ CRLF RemoteMetrics ]
            [ CRLF DialogID ]

LocalMetrics  = "LocalMetrics" HCOLON CRLF Metrics

RemoteMetrics = "RemoteMetrics" HCOLON CRLF Metrics

AlertReport   = "VQAlertReport" HCOLON
      MetricType WSP Severity WSP Direction CRLF
      SessionInfo  CRLF
      LocalMetrics [ CRLF RemoteMetrics ]
      [ DialogID ]




Pendleton, et al.            Standards Track                   [Page 10]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


SessionInfo =
   CallID CRLF
   LocalID CRLF
   RemoteID CRLF
   OrigID CRLF
   LocalAddr CRLF
   RemoteAddr CRLF
   LocalGroupID CRLF
   RemoteGroupID CRLF
   [ LocalMACAddr CRLF ]
   [ RemoteMACAddr CRLF ]

Metrics = TimeStamps CRLF
   [ SessionDescription CRLF ]
   [ JitterBuffer CRLF ]
   [ PacketLoss CRLF ]
   [ BurstGapLoss CRLF ]
   [ Delay CRLF ]
   [ Signal CRLF ]
   [ QualityEstimates CRLF ]
   *(Extension CRLF)

; Timestamps are provided in Coordinated Universal Time (UTC)
; using the ABNF format provided in RFC 3339,
;  "Date and Time on the Internet: Timestamps"
; These timestamps SHOULD reflect, as closely as
; possible, the actual time during which the media session
; was running to enable correlation to events occurring
; in the network infrastructure and to accounting records.
; Time zones other than "Z" are not allowed.

TimeStamps = "Timestamps" HCOLON StartTime WSP StopTime
StartTime  = "START" EQUAL date-time
StopTime   = "STOP" EQUAL date-time

; SessionDescription provides a shortened version of the
; session SDP but contains only the relevant parameters for
; session quality reporting purposes.

SessionDescription  = "SessionDesc" HCOLON
   [ PayloadType WSP ]
   [ PayloadDesc WSP ]
   [ SampleRate WSP ]
   [ PacketsPerSecond WSP ]
   [ FrameDuration WSP ]
   [ FrameOctets WSP ]
   [ FramesPerPacket WSP ]
   [ FmtpOptions WSP ]



Pendleton, et al.            Standards Track                   [Page 11]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   [ PacketLossConcealment WSP ]
   [ SilenceSuppressionState ]
   *(WSP Extension)

; PayloadType provides the PT parameter used in the RTP packets.

PayloadType  = "PT" EQUAL (1*3DIGIT)

; PayloadDesc provides a text description of the codec.
; This parameter SHOULD use the IANA registry for
; media-type names defined by RFC 4855 where it unambiguously
; defines the codec.  Refer to the "Audio Media Types"
; registry on http://www.iana.org.

PayloadDesc  = "PD" EQUAL (word / DQUOTE word-plus DQUOTE)

; SampleRate reports the rate at which a voice was sampled
; in the case of narrowband codecs, this value will typically
; be 8000.
; For codecs that are able to change sample rates, the lowest and
; highest sample rates MUST be reported (e.g., 8000;16000).

SampleRate = "SR" EQUAL (1*6DIGIT) *(SEMI (1*66DIGIT))

; FrameDuration can be combined with the FramesPerPacket
; to determine the packetization rate; the units for
; FrameDuration are milliseconds.  NOTE: for frame-based codecs,
; each frame constitutes a single frame; for sample-based codecs,
; a "frame" refers to the set of samples carried in an RTP packet.

FrameDuration = "FD" EQUAL (1*4DIGIT)

; FrameOctets provides the number of octets in each frame
; at the time the report is generated (i.e., last value).
; This MAY be used where FrameDuration is not available.
; NOTE: for frame-based codecs, each frame constitutes a single frame;
; for sample-based codecs, a "frame" refers to the set of samples
; carried in an RTP packet.

FrameOctets  = "FO" EQUAL (1*5DIGIT)

; FramesPerPacket provides the number of frames in each RTP
; packet at the time the report is generated.
; NOTE: for frame-based codecs, each frame constitutes a single frame;
; for sample-based codecs, a "frame" refers to the set of samples
; carried in an RTP packet.

FramesPerPacket = "FPP" EQUAL (1*2DIGIT)



Pendleton, et al.            Standards Track                   [Page 12]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


; Packets per second provides the average number of packets
; that are transmitted per second, as at the time the report is
; generated.

PacketsPerSecond = "PPS" EQUAL (1*5DIGIT)

; FMTP options from SDP.  Note that the parameter is delineated
; by " " to avoid parsing issues in transitioning between SDP
; and SIP parsing.

FmtpOptions = "FMTP" EQUAL DQUOTE word-plus DQUOTE

; PacketLossConcealment indicates whether a PLC algorithm was
; or is being used for the session.  The values follow the same
; numbering convention as RFC 3611 [4].
; 0 - unspecified
; 1 - disabled
; 2 - enhanced
; 3 - standard

PacketLossConcealment  = "PLC" EQUAL ("0" / "1" / "2" / "3")

; SilenceSuppressionState indicates whether silence suppression,
; also known as Voice Activity Detection (VAD) is enabled.

SilenceSuppressionState  = "SSUP" EQUAL ("on" / "off")

; CallId provides the call id from the SIP dialog.

CallID  =  "CallID" HCOLON Call-ID-Parm

; LocalID identifies the reporting endpoint for the media session [2].

LocalID = "LocalID" HCOLON (name-addr/addr-spec)

; RemoteID identifies the remote endpoint of the media session [2].

RemoteID = "RemoteID" HCOLON (name-addr/addr-spec)

; OrigID identifies the endpoint which originated the session.

OrigID = "OrigID" HCOLON (name-addr/addr-spec)

; LocalAddr provides the IP address, port, and SSRC of the
; endpoint/UA, which is the receiving end of the stream being
; measured.

LocalAddr   = "LocalAddr" HCOLON IPAddress WSP Port WSP Ssrc



Pendleton, et al.            Standards Track                   [Page 13]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


; RemoteAddr provides the IP address, port, and SSRC of the
; the source of the stream being measured.

RemoteAddr  = "RemoteAddr" HCOLON IPAddress WSP Port WSP Ssrc

; LocalMACAddr provides the Media Access Control (MAC) address
; of the local SIP device.

LocalMACAddr   = "LocalMAC" HCOLON hex2 *(":" hex2)

; RemoteMACAddr provides the MAC address
; of the remote SIP device.

RemoteMACAddr   = "RemoteMAC" HCOLON hex2 *(":" hex2)

; LocalGroupID provides the identification for the purposes
; of aggregation for the local endpoint.

LocalGroupID = "LocalGroup" HCOLON word-plus

; RemoteGroupID provides the identification for the purposes
; of aggregation for the remote endpoint.

RemoteGroupID = "RemoteGroup" HCOLON word-plus

; For clarification, the LocalAddr in the LocalMetrics report
; MUST be the RemoteAddr in the RemoteMetrics report.

IPAddress   = "IP" EQUAL IPv6address / IPv4address
Port        = "PORT" EQUAL 1*DIGIT
Ssrc        = "SSRC" EQUAL ( %x30.78 1*8HEXDIG)

JitterBuffer = "JitterBuffer" HCOLON
   [ JitterBufferAdaptive WSP ]
   [ JitterBufferRate WSP ]
   [ JitterBufferNominal WSP ]
   [ JitterBufferMax WSP ]
   [ JitterBufferAbsMax ]
   *(WSP Extension)

; JitterBufferAdaptive indicates whether the jitter buffer in
; the endpoint is adaptive, static, or unknown.
; The values follow the same numbering convention as RFC 3611 [4].
; For more details, please refer to that document.
; 0 - unknown
; 1 - reserved
; 2 - non-adaptive
; 3 - adaptive



Pendleton, et al.            Standards Track                   [Page 14]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


JitterBufferAdaptive  = "JBA" EQUAL ("0" / "1" / "2" / "3")

; JitterBuffer metric definitions are provided in RFC 3611 [4].

JitterBufferRate      = "JBR" EQUAL (1*2DIGIT) ;0-15
JitterBufferNominal   = "JBN" EQUAL (1*5DIGIT) ;0-65535
JitterBufferMax       = "JBM" EQUAL (1*5DIGIT) ;0-65535
JitterBufferAbsMax    = "JBX" EQUAL (1*5DIGIT) ;0-65535

; PacketLoss metric definitions are provided in RFC 3611 [4].

PacketLoss = "PacketLoss" HCOLON
           [ NetworkPacketLossRate WSP ]
           [ JitterBufferDiscardRate ]
           *(WSP Extension)

NetworkPacketLossRate =
  "NLR" EQUAL (1*3DIGIT [ "." 1*2DIGIT ]) ;percentage

JitterBufferDiscardRate =
  "JDR" EQUAL (1*3DIGIT [ "." 1*2DIGIT ]) ;percentage

; BurstGapLoss metric definitions are provided in RFC 3611 [4].

BurstGapLoss = "BurstGapLoss" HCOLON
   [ BurstLossDensity WSP ]
   [ BurstDuration WSP ]
   [ GapLossDensity WSP ]
   [ GapDuration WSP ]
   [ MinimumGapThreshold ]
   *(WSP Extension)

BurstLossDensity =
 "BLD" EQUAL (1*3DIGIT [ "." 1*2DIGIT ]) ;percentage

BurstDuration =
 "BD" EQUAL (1*7DIGIT) ;0-3,600,000 -- milliseconds

GapLossDensity =
 "GLD" EQUAL (1*3DIGIT [ "." 1*2DIGIT ]) ;percentage

GapDuration =
 "GD" EQUAL (1*7DIGIT) ;0-3,600,000 -- milliseconds








Pendleton, et al.            Standards Track                   [Page 15]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


MinimumGapThreshold =
 "GMIN" EQUAL (1*3DIGIT) ;1-255

Delay = "Delay" HCOLON
   [ RoundTripDelay WSP ]
   [ EndSystemDelay WSP ]
   [ OneWayDelay WSP ]
   [ SymmOneWayDelay WSP ]
   [ InterarrivalJitter WSP ]
   [ MeanAbsoluteJitter ]
   *(WSP Extension)

; RoundTripDelay SHALL be measured as defined in RFC 3550 [3].

RoundTripDelay = "RTD" EQUAL (1*5DIGIT) ;0-65535

; EndSystemDelay metric is defined in RFC 3611 [4].

EndSystemDelay = "ESD" EQUAL (1*5DIGIT) ;0-65535

; OneWayDelay is defined in RFC 2679 [12].

OneWayDelay = "OWD" EQUAL (1*5DIGIT) ;0-65535

; SymmOneWayDelay is defined as half the sum of RoundTripDelay
; and the EndSystemDelay values for both endpoints.

SymmOneWayDelay = "SOWD" EQUAL (1*5DIGIT); 0-65535

; Interarrival Jitter is calculated as defined RFC 3550 [3]
; and converted into milliseconds.

InterarrivalJitter = "IAJ" EQUAL (1*5DIGIT) ;0-65535 ms

; Mean Absolute Jitter is measured as defined
; by ITU-T G.1020 [9] where it is known as MAPDV.

MeanAbsoluteJitter = "MAJ" EQUAL (1*5DIGIT);0-65535

; Signal metrics definitions are provided in RFC 3611 [4].

Signal = "Signal" HCOLON
   [ SignalLevel WSP ]
   [ NoiseLevel WSP ]
   [ ResidualEchoReturnLoss ]
   *(WSP Extension)

; SignalLevel will normally be a negative value.



Pendleton, et al.            Standards Track                   [Page 16]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


; The absence of the negative sign indicates a positive value.
; Where the signal level is negative, the sign MUST be
; included.  This metric applies to the speech signal decoded
; from the received packet stream.

SignalLevel = "SL" EQUAL ([ "-" ] 1*2DIGIT)

; NoiseLevel will normally be negative and the sign MUST be
; explicitly included.
; The absence of a sign indicates a positive value.
; This metric applies to the speech signal decoded from the
; received packet stream.

NoiseLevel  = "NL" EQUAL ([ "-" ] 1*2DIGIT)

; Residual Echo Return Loss (RERL) is the ratio between
; the original signal and the echo level as measured after
; echo cancellation or suppression has been applied.
; Expressed in decibels (dB).  This is typically a positive
; value.
; This metric relates to the proportion of the speech signal
; decoded from the received packet stream that is reflected
; back in the encoded speech signal output in the transmitted
; packet stream (i.e., will affect the REMOTE user's
; conversational quality).  To support the diagnosis of echo-
; related problems experienced by the local user of the device
; generating a report according to this document, the value of
; RERL reported via the RTCP XR VoIP Metrics payload SHOULD be
; reported in the RemoteMetrics set of data.

ResidualEchoReturnLoss = "RERL" EQUAL (1*3DIGIT)

; Voice Quality estimation metrics.
; Each quality estimate has an optional associated algorithm.
; These fields permit the implementation to use a variety
; of different calculation methods for each type of metric.

QualityEstimates  = "QualityEst" HCOLON
   [ ListeningQualityR WSP ]
   [ RLQEstAlg WSP ]
   [ ConversationalQualityR WSP ]
   [ RCQEstAlg WSP ]
   [ ExternalR-In WSP ]
   [ ExtRInEstAlg WSP ]
   [ ExternalR-Out WSP ]
   [ ExtROutEstAlg WSP ]
   [ MOS-LQ WSP ]
   [ MOSLQEstAlg WSP ]



Pendleton, et al.            Standards Track                   [Page 17]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   [ MOS-CQ WSP ]
   [ MOSCQEstAlg WSP ]
   [ QoEEstAlg ]
   *(WSP Extension)

ListeningQualityR = "RLQ" EQUAL (1*3DIGIT) ; 0 - 120

RLQEstAlg = "RLQEstAlg" EQUAL word ; "P.564" [10], or other

ConversationalQualityR = "RCQ" EQUAL (1*3DIGIT) ; 0 - 120

RCQEstAlg = "RCQEstAlg" EQUAL word ; "P.564", or other

; ExternalR-In is measured by the local endpoint for incoming
; connection on the "other" side of this endpoint.  For example,
;   Phone A <---> Bridge <----> Phone B
;   ListeningQualityR = quality for Phone A ----> Bridge path
;   ExternalR-In = quality for Bridge <---- Phone B path

ExternalR-In = "EXTRI" EQUAL (1*3DIGIT) ; 0 - 120

ExtRInEstAlg = "ExtRIEstAlg" EQUAL word ; "P.564" or other

; ExternalR-Out is copied from the RTCP XR message received from the
; remote endpoint on the "other" side of this endpoint.  For example,
;   Phone A <---> Bridge <----> Phone B
;   ExternalR-Out = quality for Bridge -----> Phone B path

ExternalR-Out = "EXTRO" EQUAL (1*3DIGIT) ; 0 - 120

ExtROutEstAlg = "ExtROEstAlg" EQUAL word ; "P.564" or other

MOS-LQ = "MOSLQ" EQUAL (DIGIT [ "." 1*3DIGIT ]) ; 0.0 - 4.9

MOSLQEstAlg = "MOSLQEstAlg" EQUAL word ; "P.564" or other

MOS-CQ = "MOSCQ" EQUAL (DIGIT [ "." 1*3DIGIT ])  ; 0.0 - 4.9

MOSCQEstAlg = "MOSCQEstAlg" EQUAL word ; "P.564" or other

; QoEEstAlg provides an alternative to the separate
; estimation algorithms for use when the same algorithm
; is used for all measurements.








Pendleton, et al.            Standards Track                   [Page 18]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


QoEEstAlg = "QoEEstAlg" EQUAL word ; "P.564" or other

; DialogID provides the identification of the dialog with
; which the media session is related.  This value is taken
; from the SIP header.

DialogID  = "DialogID" COLON Call-ID-Parm *(SEMI did-parm)

did-parm  = to-tag / from-tag / word

to-tag    = "to-tag" EQUAL token

from-tag  = "from-tag" EQUAL token

; MetricType provides the metric on which a notification of
; threshold violation was based.  The more commonly used metrics
; for alerting purposes are included here explicitly, using the
; character encoding that represents the parameter in
; this ABNF.  The Extension parameter can be used to provide
; metrics that are not defined by this document.

MetricType = "Type" EQUAL "RLQ" / "RCQ" / "EXTR" /
   "MOSLQ" / "MOSCQ" /
   "BD" / "NLR" / "JDR" /
   "RTD" / "ESD" / "IAJ" /
   "RERL" / "SL" / "NL" / Extension

Direction = "Dir" EQUAL "local" / "remote"
Severity  = "Severity" EQUAL "Warning" / "Critical" /
   "Clear"

Call-ID-Parm =  word [ "@" word ]

; General ABNF notation from RFC 5234.

CRLF =  %x0D.0A
DIGIT =  %x30-39
WSP   =  SP / HTAB ; white space
SP    =  " "
HTAB  =  %x09 ; horizontal tab
HEXDIG =  DIGIT / "A" / "B" / "C" / "D" / "E" / "F" /
             "a" / "b" / "c" / "d" / "e" / "f"
DQUOTE  =  %x22 ; " (Double Quote)
ALPHA   =  %x41-5A / %x61-7A   ; A-Z / a-z







Pendleton, et al.            Standards Track                   [Page 19]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


; ABNF notation from RFC 3261.

alphanum  =  ALPHA / DIGIT
LWS  =  [ *WSP CRLF ] 1*WSP ; linear whitespace
SWS  =  [ LWS ] ; sep whitespace
SEMI =  SWS ";" SWS ; semicolon
EQUAL   =  SWS "=" SWS ; equal
COLON   =  SWS ":" SWS ; colon
HCOLON  =  *( SP / HTAB ) ":" SWS

token       =  1*(alphanum / "-" / "." / "!" / "%" / "*"
                  / "_" / "+" / "`" / "'" / "~" )

IPv4address   =  1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT
IPv6address   =  hexpart [ ":" IPv4address ]
hexpart       =  hexseq / hexseq "::" [ hexseq ] / "::"
                      [ hexseq ]
hexseq        =  hex4 *( ":" hex4)
hex4          =  1*4HEXDIG
hex2          =  2HEXDIG

; ABNF notation from RFC 3339.

date-fullyear   = 4DIGIT ; e.g. 2006
date-month      = 2DIGIT ; e.g. 01 or 11
date-mday       = 2DIGIT ; e.g. 02 or 22
time-hour       = 2DIGIT ; e.g. 01 or 13
time-minute     = 2DIGIT ; e.g. 03 or 55
time-second     = 2DIGIT ; e.g. 01 or 59
time-secfrac    = "." 1*DIGIT
time-numoffset  = ("+" / "-") time-hour ":" time-minute
time-offset     = "Z" / time-numoffset
partial-time = time-hour ":" time-minute ":" time-second [ time-secfrac]
full-date    = date-fullyear "-" date-month "-" date-mday
full-time    = partial-time time-offset
date-time    = full-date "T" full-time

; Miscellaneous definitions
;

Extension = word-plus

word  =  1*(alphanum / "-" / "." / "!" / "%" / "*" /
   "_" / "+" / "`" / "'" / "~" /
   "(" / ")" / "<" / ">" /
   ":" / "\" / DQUOTE /
   "/" / "[" / "]" / "?" )




Pendleton, et al.            Standards Track                   [Page 20]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


word-plus =  1*(alphanum /  "-"  /  "."  /  "!"  / "%" / "*" /
   "_"  /  "+"  /  "`"  /  "'"  /  "~"  /
   "("  /  ")"  /  "<"  /  ">"  /  ":"  /
   "\"  /  "/"  /  "["  /  "]"  /  "?"  /
   "{"  /  "}"  /  "="  /  " ")

4.6.2.  Parameter Definitions and Mappings

   Parameter values, codec types, and other aspects of the endpoints may
   change dynamically during a session.  The reported values of metrics
   and configuration parameters SHALL be the current value at the time
   the report is generated.

   The Packet Loss Rate and Packet Discard Rate parameters are
   calculated over the period between the starting and ending timestamps
   for the report.  These are normally calculated from a count of the
   number of lost or discarded packets divided by the count of the
   number of packets, and hence are based on the current values of these
   counters at the time the report was generated.

   Packet delay variation, signal level, noise level, and echo level are
   computed as running or interval averages, based on the appropriate
   standard, e.g., RFC 3550 for Packet Delay Variation (PDV), and the
   sampled value of these running averages is reported.  Delay, packet
   size, jitter buffer size, and codec-related data may change during a
   session and the current value of these parameters is reported as
   sampled at the time the report is generated.

4.6.2.1.  General Mapping Percentages from 8-bit, Fixed-Point Numbers

   RFC 3611 uses an 8-bit, fixed-point number with the binary point at
   the left edge of the field.  This value is calculated by dividing the
   total number of packets lost by the total number of packets expected
   and multiplying the result by 256, and then taking the integer part.

   For any RTCP XR parameter in this format, to map into the equivalent
   SIP vq-rtcpxr parameter, simply reverse the equation, i.e., divide by
   256 and take the integer part.

4.6.2.2.  Timestamps

   Following SIP and other IETF conventions, timestamps are provided in
   Coordinated Universal Time (UTC) using the ABNF format provided in
   RFC 3339 [7].  These timestamps SHOULD reflect, as closely as
   possible, the actual time during which the media session was running
   to enable correlation to related events occurring in the network and
   to accounting or billing records.




Pendleton, et al.            Standards Track                   [Page 21]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.6.2.3.  SessionDescription

   The parameters in this field provide a shortened version of the
   session SDP(s), containing only the relevant parameters for session
   quality reporting purposes.  Where values may change during a
   session, for example, a codec may change rate, then the most-recent
   value of the parameter is reported.

4.6.2.3.1.  Payload Type

   This is the "payload type" parameter used in the RTP packets, i.e.,
   the codec.  This field can also be mapped from the SDP "rtpmap"
   attribute field "payload type".  IANA-registered types SHOULD be
   used.

4.6.2.3.2.  Payload Desc

   This parameter is a text description of the codec.  This parameter
   SHOULD use the IANA registry for media-type names where it
   unambiguously defines the codec.  Refer to the "Audio Media Types"
   registry on http://www.iana.org.

4.6.2.3.3.  Sample Rate

   This parameter is mapped from the SDP "rtpmap" attribute field "clock
   rate".  The field provides the rate at which a voice was sampled,
   measured in Hertz (Hz).

4.6.2.3.4.  Packets Per Second

   This parameter is not contained in RTP or SDP but can usually be
   obtained from the device codec.  Packets per second provides the
   (rounded) number of RTP packets that are transmitted per second.

4.6.2.3.5.  Frame Duration

   This parameter is not contained in RTP or SDP but can usually be
   obtained from the device codec.  The field reflects the amount of
   voice content in each frame within the RTP payload, measured in
   milliseconds.  Note that this value can be combined with the
   FramesPerPacket to determine the packetization rate.  Also, where a
   sample-based codec is used, a "frame" refers to the set of samples
   carried in an RTP packet.








Pendleton, et al.            Standards Track                   [Page 22]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.6.2.3.6.  Frame Octets

   This parameter is not contained in RTP or SDP but is usually provided
   by the device codec.  The field provides the number of octets in each
   frame within the RTP payload.  This field is usually not provided
   when the FrameDuration is provided.  Also, where a sample-based codec
   is used, a "frame" refers to the set of samples carried in an RTP
   packet.

4.6.2.3.7.  Frames Per Packet

   This parameter is not contained in RTP or SDP but can usually be
   obtained from the device codec.  This field provides the number of
   frames in each RTP packet.  Note that this value can be combined with
   the FrameDuration to determine the packetization rate.  Also, where a
   sample-based codec is used, a "frame" refers to the set of samples
   carried in an RTP packet.

4.6.2.3.8.  FMTP Options

   This parameter is taken directly from the SDP attribute "fmtp"
   defined in RFC 4566.

4.6.2.3.9.  Silence Suppression State

   This parameter does not correspond to SDP, RTP, or RTCP XR.  It
   indicates whether silence suppression, also known as Voice Activity
   Detection (VAD), is enabled for the identified session.

4.6.2.3.10.  Packet Loss Concealment

   This value corresponds to "PLC" in RFC 3611 in the VoIP Metrics
   Report Block.  The values defined by RFC 3611 are reused by this
   recommendation and therefore no mapping is required.

4.6.2.4.  LocalAddr

   This field provides the IP address, port, and synchronization source
   (SSRC) for the session from the perspective of the endpoint that is
   measuring performance.  The IPAddress MAY be in IPv4 or IPv6 format.
   The SSRC is taken from SDP, RTCP, or RTCP XR input parameters.

   In the presence of NAT and where a NAT-traversal mechanism such as
   Session Traversal Utilities for NAT (STUN) [16] is used, the external
   IP address can be reported, since the internal IP address is not
   visible to the network operator.





Pendleton, et al.            Standards Track                   [Page 23]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.6.2.5.  RemoteAddr

   This field provides the IP address, port, and SSRC of the session
   peer from the perspective of the remote endpoint measuring
   performance.  In the presence of NAT and where a NAT-traversal
   mechanism such as STUN [16] is used, the external IP address can be
   reported, since the internal IP address is not visible to the network
   operator.

4.6.2.6.  Jitter Buffer Parameters

4.6.2.6.1.  Jitter Buffer Adaptive

   This value corresponds to "JBA" in RFC 3611 in the VoIP Metrics
   Report Block.  The values defined by RFC 3611 are unchanged and
   therefore no mapping is required.

4.6.2.6.2.  Jitter Buffer Rate

   This value corresponds to "JB rate" in RFC 3611 in the VoIP Metrics
   Report Block.  The parameter does not require any conversion.

4.6.2.6.3.  Jitter Buffer Nominal

   This value corresponds to "JB nominal" in RFC 3611 in the VoIP
   Metrics Report Block.  The parameter does not require any conversion.

4.6.2.6.4.  Jitter Buffer Max

   This value corresponds to "JB maximum" in RFC 3611 in the VoIP
   Metrics Report Block.  The parameter does not require any conversion.

4.6.2.6.5.  Jitter Buffer Abs Max

   This value corresponds to "JB abs max" in RFC 3611 in the VoIP
   Metrics Report Block.  The parameter does not require any conversion.

4.6.2.7.  Packet Loss Parameters

4.6.2.7.1.  Network Loss Rate

   This value corresponds to "loss rate" in RFC 3611 in the VoIP Metrics
   Report Block.  For conversion, see Section 4.6.2.1.  A loss rate of
   100% MAY be reported if media packets were expected but none had been
   received at the time of session termination.






Pendleton, et al.            Standards Track                   [Page 24]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.6.2.7.2.  Jitter Buffer Discard Rate

   This value corresponds to "discard rate" in RFC 3611 in the VoIP
   Metrics Report Block.  For conversion, see Section 4.6.2.1.

4.6.2.8.  Burst/Gap Parameters

4.6.2.8.1.  Burst Loss Density

   This value corresponds to "burst density" in RFC 3611 in the VoIP
   Metrics Report Block.  For conversion, see Section 4.6.2.1.

4.6.2.8.2.  Burst Duration

   This value corresponds to "burst duration" in RFC 3611 in the VoIP
   Metrics Report Block.  This value requires no conversion; the exact
   value sent in an RTCP XR VoIP Metrics Report Block can be included in
   the SIP vq-rtcpxr parameter.

4.6.2.8.3.  Gap Loss Density

   This value corresponds to "gap density" in RFC 3611 in the VoIP
   metrics Report Block.

4.6.2.8.4.  Gap Duration

   This value corresponds to "gap duration" in RFC 3611 in the VoIP
   Metrics Report Block.  This value requires no conversion; the exact
   value sent in an RTCP XR VoIP Metrics Report Block can be reported.

4.6.2.8.5.  Minimum Gap Threshold

   This value corresponds to "Gmin" in RFC 3611 in the VoIP Metrics
   Report Block.  This value requires no conversion; the exact value
   sent in an RTCP XR VoIP Metrics Report Block can be reported.

4.6.2.9.  Delay Parameters

4.6.2.9.1.  Round-Trip Delay

   This value corresponds to "round trip delay" in RFC 3611 in the VoIP
   Metrics Report Block and may be measured using the method defined in
   RFC 3550.  The parameter is expressed in milliseconds.








Pendleton, et al.            Standards Track                   [Page 25]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.6.2.9.2.  End System Delay

   This value corresponds to "end system delay" in RFC 3611 in the VoIP
   Metrics Report Block.  This parameter does not require any
   conversion.  The parameter is expressed in milliseconds.

4.6.2.9.3.  Symmetric One-Way Delay

   This value is computed by adding Round-Trip Delay to the local and
   remote End System Delay and dividing by two.

4.6.2.9.4.  One-Way Delay

   This value SHOULD be measured using the methods defined in IETF RFC
   2679 [12].  The parameter is expressed in milliseconds.

4.6.2.9.5.  Inter-Arrival Jitter

   Inter-arrival jitter is calculated as defined in RFC 3550 and
   converted into milliseconds.

4.6.2.9.6.  Mean Absolute Jitter

   It is recommended that MAJ be measured as defined in ITU-T G.1020
   [9].  This parameter is often referred to as MAPDV (Mean Absolute
   Packet Delay Variation).  The parameter is expressed in milliseconds.

4.6.2.10.  Signal-Related Parameters

4.6.2.10.1.  Signal Level

   This field corresponds to "signal level" in RFC 3611 in the VoIP
   Metrics Report Block.  This field provides the voice signal relative
   level is defined as the ratio of the signal level to a 0 dBm0
   reference, expressed in decibels.  This value can be used directly
   without extra conversion.

4.6.2.10.2.  Noise Level

   This field corresponds to "noise level" in RFC 3611 in the VoIP
   Metrics Report Block.  This field provides the ratio of the silent
   period background noise level to a 0 dBm0 reference, expressed in
   decibels.  This value can be used directly without extra conversion.








Pendleton, et al.            Standards Track                   [Page 26]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.6.2.10.3.  Residual Echo Return Loss (RERL)

   This field corresponds to "RERL" in RFC 3611 in the VoIP Metrics
   Report Block.  This field provides the ratio between the original
   signal and the echo level in decibels, as measured after echo
   cancellation or suppression has been applied.  This value can be used
   directly without extra conversion.

4.6.2.11.  Quality Scores

4.6.2.11.1.  ListeningQualityR

   This field reports the listening quality expressed as an R factor
   (per G.107).  This does not include the effects of echo or delay.
   The range of R is 0-95 for narrowband calls and 0-120 for wideband
   calls.  Algorithms for computing this value SHOULD be compliant with
   ITU-T Recommendations P.564 [10] and G.107 [11].

4.6.2.11.2.  RLQEstAlg

   This field provides a text name for the algorithm used to estimate
   ListeningQualityR.  This field will be free form text and not
   necessarily reflective of any standards or recommendations.

4.6.2.11.3.  ConversationalQualityR

   This field corresponds to "R factor" in RFC 3611 in the VoIP Metrics
   Report Block.  This parameter provides a cumulative measurement of
   voice quality from the start of the session to the reporting time.
   The range of R is 0-95 for narrowband calls and 0-120 for wideband
   calls.  Algorithms for computing this value SHOULD be compliant with
   ITU-T Recommendations P.564 and G.107.  Within RFC 3611, a reported R
   factor of 127 indicates that this parameter is unavailable; in this
   case, the ConversationalQualityR parameter MUST be omitted from the
   vq-rtcpxr event.

4.6.2.11.4.  RCQEstAlg

   This field provides a text name for the algorithm used to estimate
   ConversationalQualityR.  This field will be free form text and not
   necessarily reflective of any standards or recommendations.

4.6.2.11.5.  ExternalR-In

   This field corresponds to "ext. R factor" in RFC 3611 in the VoIP
   Metrics Report Block.  This parameter reflects voice quality as
   measured by the local endpoint for incoming connection on "other"
   side (refer to RFC 3611 for a more-detailed explanation).  The range



Pendleton, et al.            Standards Track                   [Page 27]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   of R is 0-95 for narrowband calls and 0-120 for wideband calls.
   Algorithms for computing this value SHOULD be compliant with ITU-T
   Recommendations P.564 and G.107.  Within RFC 3611, a reported R
   factor of 127 indicates that this parameter is unavailable; in this
   case, the ConversationalQualityR parameter MUST be omitted from the
   vq-rtcpxr event.

4.6.2.11.6.  ExtRInEstAlg

   This field provides a text name for the algorithm used to estimate
   ExternalR-In.  This field will be free-form text and not necessarily
   reflective of any standards or recommendations.

4.6.2.11.7.  ExternalR-Out

   This field corresponds to "ext. R factor" in RFC 3611 in the VoIP
   Metrics Report Block.  Here, the value is copied from RTCP XR message
   received from the remote endpoint on the "other" side of this
   endpoint; refer to RFC 3611 for a more detailed explanation).  The
   range of R is 0-95 for narrowband calls and 0-120 for wideband calls.
   Algorithms for computing this value SHOULD be compliant with ITU-T
   Recommendations P.564 and G.107.  Within RFC 3611, a reported R
   factor of 127 indicates that this parameter is unavailable; in this
   case, the ConversationalQualityR parameter SHALL be omitted from the
   vq-rtcpxr event.

4.6.2.11.8.  ExtROutEstAlg

   This field provides a text name for the algorithm used to estimate
   ExternalR-Out.  This field will be free-form text and not necessarily
   reflective of any standards or recommendations.

4.6.2.11.9.  MOS Reporting

   Conversion of RFC 3611 reported mean opinion scores (MOSs) for use in
   reporting MOS-LQ and MOS-CQ MUST be performed by dividing the RFC
   3611 reported value by 10 if this value is less than or equal to 50
   or omitting the MOS-xQ parameter if the RFC 3611 reported value is
   127 (which indicates unavailable).

4.6.2.11.9.1.  MOS-LQ

   This field corresponds to "MOSLQ" in RFC 3611 in the VoIP Metrics
   Report Block.  This parameter is the estimated mean opinion score for
   listening voice quality on a scale from 1 to 5, in which 5 represents
   "Excellent" and 1 represents "Unacceptable".  Algorithms for





Pendleton, et al.            Standards Track                   [Page 28]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   computing this value SHOULD be compliant with ITU-T Recommendation
   P.564 [10].  This field provides a text name for the algorithm used
   to estimate MOS-LQ.

4.6.2.11.9.2.  MOS-CQ

   This field corresponds to "MOSCQ" in RFC 3611 in the VoIP Metrics
   Report Block.  This parameter is the estimated mean opinion score for
   conversation voice quality on a scale from 1 to 5, in which 5
   represents excellent and 1 represents unacceptable.  Algorithms for
   computing this value SHOULD be compliant with ITU-T Recommendation
   P.564 with regard to the listening quality element of the computed
   MOS score.

4.6.2.11.9.3.  MOSCQEstAlg

   This field provides a text name for the algorithm used to estimate
   MOS-CQ.  This field will be free-form text and not necessarily
   reflective of any standards or recommendations.

4.6.2.11.10.  QoEEstAlg

   This field provides a text description of the algorithm used to
   estimate all voice quality metrics.  This parameter is provided as an
   alternative to the separate estimation algorithms for use when the
   same algorithm is used for all measurements.  This field will be
   free-form text and not necessarily reflective of any standards or
   recommendations.

4.7.  Message Flow and Syntax Examples

   This section shows a number of message flow examples showing how the
   event package works.

4.7.1.  End of Session Report Using NOTIFY
















Pendleton, et al.            Standards Track                   [Page 29]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


       Alice            Proxy/Registrar        Collector             Bob
       |                    |                    |                    |
       |                    |                    |                    |
       | REGISTER Allow-Event:vq-rtcpxr F1       |                    |
       |------------------->|                    |                    |
       |      200 OK F2     |                    |                    |
       |<-------------------|                    |                    |
       |                    |  SUBSCRIBE Event:vq-rtcpxr F3           |
       |                    |<-------------------|                    |
       | SUBSCRIBE Event:vq-rtcpxr F4            |                    |
       |<-------------------|                    |                    |
       |     200 OK F5      |                    |                    |
       |------------------->|                    |                    |
       |                    |   200 OK F6        |                    |
       |                    |------------------->|                    |
       |      INVITE F7     |                    |                    |
       |------------------->|                    |                    |
       |                    |      INVITE F8     |                    |
       |                    |---------------------------------------->|
       |                    |      200 OK F9     |                    |
       |                    |<----------------------------------------|
       |     200 OK F10     |                    |                    |
       |<-------------------|                    |                    |
       |        ACK F11     |                    |                    |
       |------------------->|                    |                    |
       |                    |      ACK F12       |                    |
       |                    |---------------------------------------->|
       |        RTP         |                    |                    |
       |<============================================================>|
       |        RTCP, RTCP XR                    |                    |
       |<============================================================>|
       |                    |                    |                    |
       |    BYE F13         |                    |                    |
       |------------------->|      BYE F14       |                    |
       |                    |---------------------------------------->|
       |                    |     200 OK F15     |                    |
       |                    |<----------------------------------------|
       |     200 OK F16     |                    |                    |
       |<-------------------|                    |                    |
       |  NOTIFY Event:vq-rtcpxr F17             |                    |
       |------------------->|                    |                    |
       |                    | NOTIFY Event:vq-rtcpxr F18              |
       |                    |------------------->|                    |
       |                    |     200 OK F19     |                    |
       |                    |<-------------------|                    |
       |     200 OK F20     |                    |                    |
       |<-------------------|                    |                    |




Pendleton, et al.            Standards Track                   [Page 30]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   Figure 1. Summary report with NOTIFY sent after session termination.
   In the call flow depicted in Figure 1, the following message format
   is sent in F17:

       NOTIFY sip:collector@example.org SIP/2.0
       Via: SIP/2.0/UDP pc22.example.org;branch=z9hG4bK3343d7
       Max-Forwards: 70
       To: <sip:collector@example.org>;tag=43524545
       From: Alice <sip:alice@example.org>;tag=a3343df32
       Call-ID: 1890463548
       CSeq: 4321 NOTIFY
       Contact: <sip:alice@pc22.example.org>
       Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER,
        SUBSCRIBE, NOTIFY
       Event: vq-rtcpxr
       Accept: application/sdp, message/sipfrag
       Subscription-State: active;expires=3600
       Content-Type: application/vq-rtcpxr
       Content-Length: ...

       VQSessionReport: CallTerm
       CallID: 6dg37f1890463
       LocalID: Alice <sip:alice@example.org>
       RemoteID: Bill <sip:bill@example.net>
       OrigID: Alice <sip:alice@example.org>
       LocalGroup: example-phone-55671
       RemoteGroup: example-gateway-09871
       LocalAddr: IP=10.10.1.100 PORT=5000 SSRC=1a3b5c7d
       LocalMAC: 00:1f:5b:cc:21:0f
       RemoteAddr:IP=11.1.1.150 PORT=5002 SSRC=0x2468abcd
       RemoteMAC: 00:26:08:8e:95:02
       LocalMetrics:
       Timestamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z
       SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50
                       PLC=3 SSUP=on
       JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120
       PacketLoss:NLR=5.0 JDR=2.0
       BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16
       Delay:RTD=200 ESD=140 SOWD=200 IAJ=2 MAJ=10
       Signal:SL=-18 NL=-50 RERL=55
       QualityEst:RLQ=88 RCQ=85 EXTRI=90 MOSLQ=4.1 MOSCQ=4.0
         QoEEstAlg=P.564
       RemoteMetrics:
       Timestamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z
       SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50
                       PLC=3 SSUP=on
       JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120
       PacketLoss:NLR=5.0 JDR=2.0



Pendleton, et al.            Standards Track                   [Page 31]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


       BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16
       Delay:RTD=200 ESD=140 SOWD=200 IAJ=2 MAJ=10
       Signal:SL=-21 NL=-45 RERL=55
       QualityEst:RLQ=90 RCQ=85 EXTRI=90 MOSLQ=4.3 MOSCQ=4.2
         QoEEstAlg=P.564
       DialogID:1890463548@alice.example.org;to-tag=8472761;
         from-tag=9123dh311

4.7.2.  Midsession Threshold Violation Using NOTIFY

   Alice            Proxy/Registrar        Collector             Bob
    |                    |                    |                    |
    |                    |                    |                    |
    | REGISTER Allow-Event:vq-rtcpxr F1       |                    |
    |------------------->|                    |                    |
    |      200 OK F2     |                    |                    |
    |<-------------------|                    |                    |
    |                    |  SUBSCRIBE Event:vq-rtcpxr F3           |
    |                    |<-------------------|                    |
    | SUBSCRIBE Event:vq-rtcpxr F4            |                    |
    |<-------------------|                    |                    |
    |     200 OK F5      |                    |                    |
    |------------------->|                    |                    |
    |                    |   200 OK F6        |                    |
    |                    |------------------->|                    |
    |      INVITE F7     |                    |                    |
    |------------------->|                    |                    |
    |                    |      INVITE F8     |                    |
    |                    |---------------------------------------->|
    |                    |      200 OK F9     |                    |
    |                    |<----------------------------------------|
    |     200 OK F10     |                    |                    |
    |<-------------------|                    |                    |
    |        ACK F11     |                    |                    |
    |------------------->|                    |                    |
    |                    |      ACK F12       |                    |
    |                    |---------------------------------------->|
    |        RTP         |                    |                    |
    |<============================================================>|
    |        RTCP, RTCP XR                    |                    |
    |<============================================================>|
    |  NOTIFY Event:vq-rtcpxr F13             |                    |
    |------------------->|                    |                    |
    |                    | NOTIFY Event:vq-rtcpxr F14              |
    |                    |------------------->|                    |
    |                    |     200 OK F15     |                    |
    |                    |<-------------------|                    |
    |     200 OK F16     |                    |                    |



Pendleton, et al.            Standards Track                   [Page 32]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


    |<-------------------|                    |                    |
    |                    |                    |                    |
    |    BYE F17         |                    |                    |
    |------------------->|      BYE F18       |                    |
    |                    |---------------------------------------->|
    |                    |     200 OK F19     |                    |
    |                    |<----------------------------------------|
    |     200 OK F20     |                    |                    |
    |<-------------------|                    |                    |
    |  NOTIFY Event:vq-rtcpxr F21             |                    |
    |------------------->|                    |                    |
    |                    | NOTIFY Event:vq-rtcpxr F22              |
    |                    |------------------->|                    |
    |                    |     200 OK F23     |                    |
    |                    |<-------------------|                    |
    |     200 OK F24     |                    |                    |
    |<-------------------|                    |                    |

   Figure 2.  An alert report is sent during the session.
   In the call flow depicted in Figure 2, the following message
   format is sent in F13:

       NOTIFY sip:collector@example.org SIP/2.0
       Via: SIP/2.0/UDP pc22.example.org;branch=z9hG4bK3343d7
       Max-Forwards: 70
       To: <sip:proxy@example.org>
       From: Alice <sip:alice@example.org>;tag=a3343df32
       Call-ID: 1890463548
       CSeq: 4331 PUBLISH
       Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER,
        SUBSCRIBE, NOTIFY
       Event: vq-rtcpxr
       Accept: application/sdp, message/sipfrag
       Content-Type: application/vq-rtcpxr
       Content-Length: ...

       VQAlertReport: Type=NLR Severity=Critical Dir=local
       CallID: 6dg37f1890463
       LocalID: Alice <sip:alice@example.org>
       RemoteID: Bill <sip:bill@example.org>
       OrigID: Alice <sip:alice@example.org>
       LocalGroup: example-phone-55671
       RemoteGroup: example-gateway-09871
       LocalAddr:IP=10.10.1.100 PORT=5000 SSRC=0x2468abcd
       LocalMAC: 00:1f:5b:cc:21:0f






Pendleton, et al.            Standards Track                   [Page 33]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


       RemoteAddr:IP=11.1.1.150 PORT=5002 SSRC=1357efff
       RemoteMAC: 00:26:08:8e:95:02
       LocalMetrics:
       Timestamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z
       SessionDesc:PT=18 PD=G729 SR=8000 FD=20 FO=20 FPP=2 PPS=50
                       FMTP="annexb=no" PLC=3 SSUP=on
       JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120
       PacketLoss:NLR=10.0 JDR=2.0
       BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16
       Delay:RTD=200 ESD=140 SOWD=200 IAJ=2 MAJ=10
       Signal:SL=-21 NL=-50 RERL=55
       QualityEst:RLQ=80 RCQ=85 EXTRI=90 MOSLQ=3.5 MOSCQ=3.7
                        QoEEstAlg=P.564
       RemoteMetrics:
       Timestamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z
       SessionDesc:PT=18 PD=G729 SR=8000 FD=20 FO=20 FPP=2 PPS=50
                       FMTP="annexb=no" PLC=3 SSUP=on
       JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120
       PacketLoss:NLR=5.0 JDR=2.0
       BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16
       Delay:RTD=200 ESD=140 SOWD=200 IAJ=2 MAJ=10
       Signal:SL=-21 NL=-45 RERL=55
       QualityEst:RLQ=90 RCQ=85 MOSLQ=4.3 MOSCQ=4.2 QoEEstAlg=P.564
       DialogID:1890463548@alice.example.org;to-tag=8472761;
          from-tag=9123dh311


























Pendleton, et al.            Standards Track                   [Page 34]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.7.3.  End of Session Report Using PUBLISH

      Alice            Proxy/Registrar        Collector              Bob
       |                    |                    |                    |
       |                    |                    |                    |
       | REGISTER Allow-Event:vq-rtcpxr  F1      |                    |
       |------------------->|                    |                    |
       |      200 OK F2     |                    |                    |
       |<-------------------|                    |                    |
       |      INVITE F3     |                    |                    |
       |------------------->|                    |                    |
       |                    |      INVITE F4     |                    |
       |                    |---------------------------------------->|
       |                    |      200 OK F5     |                    |
       |                    |<----------------------------------------|
       |     200 OK F6      |                    |                    |
       |<-------------------|                    |                    |
       |        ACK F7      |                    |                    |
       |------------------->|                    |                    |
       |                    |      ACK F8        |                    |
       |                    |---------------------------------------->|
       |        RTP         |                    |                    |
       |<============================================================>|
       |        RTCP        |                    |                    |
       |<============================================================>|
       |                    |                    |                    |
       |    BYE F9          |                    |                    |
       |------------------->|      BYE F10       |                    |
       |                    |---------------------------------------->|
       |                    |     200 OK F11     |                    |
       |                    |<----------------------------------------|
       |     200 OK F12     |                    |                    |
       |<-------------------|                    |                    |
       |  PUBLISH Event:vq-rtcpxr F13            |                    |
       |------------------->|                    |                    |
       |                    | PUBLISH Event:vq-rtcpxr F14             |
       |                    |------------------->|                    |
       |                    |     200 OK F15     |                    |
       |                    |<-------------------|                    |
       |     200 OK F16     |                    |                    |
       |<-------------------|                    |                    |

   Figure 3. End of session report sent after session termination.
   In the message flow depicted in Figure 3, the following message is
   sent in F13.






Pendleton, et al.            Standards Track                   [Page 35]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


       PUBLISH sip:collector@example.org SIP/2.0
       Via: SIP/2.0/UDP pc22.example.org;branch=z9hG4bK3343d7
       Max-Forwards: 70
       To: <sip:proxy@example.org>
       From: Alice <sip:alice@example.org>;tag=a3343df32
       Call-ID: 1890463548
       CSeq: 4331 PUBLISH
       Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER,
        SUBSCRIBE, NOTIFY
       Event: vq-rtcpxr
       Accept: application/sdp, message/sipfrag
       Content-Type: application/vq-rtcpxr
       Content-Length: ...

       VQSessionReport: CallTerm
       CallID: 6dg37f1890463
       LocalID: Alice <sip:alice@example.org>
       RemoteID: Bill <sip:bill@example.net>
       OrigID: Alice <sip:alice@example.org>
       LocalGroup: example-phone-55671
       RemoteGroup: example-gateway-09871
       LocalAddr: IP=10.10.1.100 PORT=5000 SSRC=1a3b5c7d
       LocalMAC: 00:1f:5b:cc:21:0f
       RemoteAddr:IP=11.1.1.150 PORT=5002 SSRC=0x2468abcd
       RemoteMAC: 00:26:08:8e:95:02
       LocalMetrics:
       Timestamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z
       SessionDesc:PT=18 PD=G729 SR=8000 FD=20 FO=20 FPP=2 PPS=50
                       FMTP="annexb=no" PLC=3 SSUP=on
       JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120
       PacketLoss:NLR=5.0 JDR=2.0
       BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16
       Delay:RTD=200 ESD=140 SOWD=200 IAJ=2 MAJ=10
       Signal:SL=-21 NL=-50 RERL=55
       QualityEst:RLQ=90 RCQ=85 EXTRI=90 MOSLQ=4.2 MOSCQ=4.3
         QoEEstAlg=P.564
       RemoteMetrics:
       Timestamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z
       SessionDesc:PT=18 PD=G729 SR=8000 FD=20 FO=20 FPP=2 PPS=50
                       FMTP="annexb=no" PLC=3 SSUP=on
       JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120
       PacketLoss:NLR=5.0 JDR=2.0
       BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16
       Delay:RTD=200 ESD=140 SOWD=200 IAJ=2 MAJ=10
       Signal:SL=-21 NL=-45 RERL=55
       QualityEst:RLQ=90 RCQ=85 MOSLQ=4.3 MOSCQ=4.2 QoEEstAlg=P.564
       DialogID:1890463548@alice.example.org;to-tag=8472761;
          from-tag=9123dh311



Pendleton, et al.            Standards Track                   [Page 36]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.7.4.  Alert Report Using PUBLISH

       Alice            Proxy/Registrar        Collector             Bob
       |                    |                    |                    |
       |      INVITE F1     |                    |                    |
       |------------------->|                    |                    |
       |                    |      INVITE F2     |                    |
       |                    |---------------------------------------->|
       |                    |      200 OK F3     |                    |
       |                    |<----------------------------------------|
       |     200 OK F4      |                    |                    |
       |<-------------------|                    |                    |
       |        ACK F5      |                    |                    |
       |------------------->|                    |                    |
       |                    |      ACK F6        |                    |
       |                    |---------------------------------------->|
       |        RTP         |                    |                    |
       |<============================================================>|
       |        RTCP        |                    |                    |
       |<============================================================>|
       |  PUBLISH Event:vq-rtcpxr F7             |                    |
       |------------------->|                    |                    |
       |                    | PUBLISH Event:vq-rtcpxr F8              |
       |                    |------------------->|                    |
       |                    |     200 OK F9      |                    |
       |                    |<-------------------|                    |
       |     200 OK F10     |                    |                    |
       |<-------------------|                    |                    |
       |                    |                    |                    |
       |      BYE F11       |                    |                    |
       |------------------->|      BYE F12       |                    |
       |                    |---------------------------------------->|
       |                    |     200 OK F13     |                    |
       |                    |<----------------------------------------|
       |     200 OK F14     |                    |                    |
       |<-------------------|                    |                    |

   Figure 4. Alert report message flow

      In the message flow depicted in Figure 4, the following message is
      sent in F7:

       PUBLISH sip:collector@example.org SIP/2.0
       Via: SIP/2.0/UDP pc22.example.org;branch=z9hG4bK3343d7
       Max-Forwards: 70
       To: <sip:collector@example.org>
       From: Alice <sip:alice@example.org>;tag=a3343df32
       Call-ID: 1890463548



Pendleton, et al.            Standards Track                   [Page 37]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


       CSeq: 4321 PUBLISH
       Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER,
        SUBSCRIBE, NOTIFY
       Event: vq-rtcpxr
       Accept: application/sdp, message/sipfrag
       Content-Type: application/vq-rtcpxr
       Content-Length: ...

       VQAlertReport: Type=RLQ Severity=Warning Dir=local
       CallID: 6dg37f1890463
       LocalID: Alice <sip:alice@example.org>
       RemoteID: Bill <sip:bill@example.org>
       OrigID: Alice <sip:alice@example.org>
       LocalGroup: example-phone-55671
       RemoteGroup: example-gateway-09871
       LocalAddr: IP=10.10.1.100 PORT=5000 SSRC=1a3b5c7d
       LocalMAC: 00:1f:5b:cc:21:0f
       RemoteAddr:IP=11.1.1.150 PORT=5002 SSRC=0x2468abcd
       RemoteMAC: 00:26:08:8e:95:02
       Metrics:
       Timestamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z
       SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50
                       PLC=3 SSUP=on
       JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120
       PacketLoss:NLR=5.0 JDR=2.0
       BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16
       Delay:RTD=200 ESD=140 SOWD=200 IAJ=2 MAJ=10
       Signal:SL=-12 NL=-30 RERL=55
       QualityEst:RLQ=60 RCQ=55 EXTR=90 MOSLQ=2.4 MOSCQ=2.3
          QoEEstAlg=P.564
       RemoteMetrics:
       Timestamps:START=2004-10-10T18:23:43Z STOP=2004-10-01T18:26:02Z
       SessionDesc:PT=0 PD=PCMU SR=8000 FD=20 FO=160 FPP=1 PPS=50
                       PLC=3 SSUP=on
       JitterBuffer:JBA=3 JBR=2 JBN=40 JBM=80 JBX=120
       PacketLoss:NLR=5.0 JDR=2.0
       BurstGapLoss:BLD=0 BD=0 GLD=2.0 GD=500 GMIN=16
       Delay:RTD=200 ESD=140 SOWD=200 IAJ=2 MAJ=10
       Signal:SL=-23 NL=-60 RERL=55
       QualityEst:RLQ=90 RCQ=85 EXTRI=90 MOSLQ=4.2 MOSCQ=4.3
          QoEEstAlg=P.564
       DialogID:1890463548@alice.example.org;to-tag=8472761;
               from-tag=9123dh3111








Pendleton, et al.            Standards Track                   [Page 38]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


4.8.  Configuration Dataset for vq-rtcpxr Events

   It is the suggestion of the authors that the SIP configuration
   framework [15] be used to establish the necessary parameters for
   usage of vq-rtcpxr events.  A dataset for this purpose should be
   designed and documented in a separate document upon completion of the
   framework.

5.  IANA Considerations

   This document registers a new SIP Event Package and a new media type.

5.1.  SIP Event Package Registration

      Package name: vq-rtcpxr
      Type: package
      Contact: Amy Pendleton <aspen@telchemy.com>
      Published Specification: This document

5.2.  application/vq-rtcpxr Media Type Registration

   Type name: application
   Subtype name: vq-rtcpxr
   Required parameters: none
   Optional parameters: none
   Encoding considerations: 7 bit
   Security considerations: See next section.
   Interoperability considerations: none.
   Published specification: This document.

   Applications that use this media type: This document type is
      being used in notifications of VoIP quality reports.

   Additional Information:

      Magic Number: None
      File Extension: None
      Macintosh file type code: "TEXT"

   Person and email address for further information: Amy Pendleton
      <aspen@telchemy.com>

   Intended usage: COMMON

   Author / Change controller: The IETF.






Pendleton, et al.            Standards Track                   [Page 39]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


6.  Security Considerations

   RTCP reports can contain sensitive information since they can provide
   information about the nature and duration of a session established
   between two or more endpoints.  As a result, any third party wishing
   to obtain this information SHOULD be properly authenticated by the
   SIP UA using standard SIP mechanisms and according to the
   recommendations in [5].  Additionally, the event content MAY be
   encrypted to ensure confidentiality; the mechanisms for providing
   confidentiality are detailed in [2].

7.  Contributors

   The authors would like to thank Rajesh Kumar, Dave Oran, Tom Redman,
   Shane Holthaus, and Jack Ford for their comments and input.

8.  References

8.1.  Normative References

   [1]   Bradner, S., "Key words for use in RFCs to Indicate Requirement
         Levels", BCP 14, RFC 2119, March 1997.

   [2]   Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A.,
         Peterson, J., Sparks, R., Handley, M., and E. Schooler, "SIP:
         Session Initiation Protocol", RFC 3261, June 2002.

   [3]   Schulzrinne, H., Casner, S., Frederick, R., and V. Jacobson,
         "RTP: A Transport Protocol for Real-Time Applications", STD 64,
         RFC 3550, July 2003.

   [4]   Friedman, T., Caceres, R., and A. Clark, "RTP Control Protocol
         Extended Reports (RTCP XR)", RFC 3611, November 2003.

   [5]   Roach, A., "Session Initiation Protocol (SIP)-Specific Event
         Notification", RFC 3265, June 2002.

   [6]   Crocker, D. and P. Overell, "Augmented BNF for Syntax
         Specifications: ABNF", STD 68, RFC 5234, January 2008.

   [7]   Klyne, G., Ed. and C. Newman, "Date and Time on the Internet:
         Timestamps", RFC 3339, July 2002.

   [8]   Niemi, A., "Session Initiation Protocol (SIP) Extension for
         Event State Publication", RFC 3903, October 2004.

   [9]   ITU-T G.1020, "Performance parameter definitions for quality of
         speech and other voiceband applications utilizing IP networks".



Pendleton, et al.            Standards Track                   [Page 40]
^L
RFC 6035         SIP Package for Voice Quality Reporting   November 2010


   [10]  ITU-T P.564, "Conformance testing for voice over IP
         transmission quality assessment models".

   [11]  ITU-T G.107, "The E-model, a computational model for use in
         transmission planning".

   [12]  Almes, G., Kalidindi, S., and M. Zekauskas, "A One-way Delay
         Metric for IPPM", RFC 2679, September 1999.

8.2.  Informative References

   [13]  Westerlund, M. and S. Wenger, "RTP Topologies", RFC 5117,
         January 2008.

   [14]  Hilt, V., Noel, E., Shen, C., and A. Abdelal, "Design
         Considerations for Session Initiation Protocol (SIP) Overload
         Control", Work in Progress, July 2009.

   [15]  Petrie, D. and S. Channabasappa, "A Framework for Session
         Initiation Protocol User Agent Profile Delivery", Work
         in Progress, October 2010.

   [16]  Rosenberg, J., Mahy, R., Matthews, P., and D. Wing, "Session
         Traversal Utilities for NAT (STUN)", RFC 5389, October 2008.

Authors' Addresses

   Amy Pendleton
   Telchemy Incorporated
   EMail: aspen@telchemy.com


   Alan Clark
   Telchemy Incorporated
   EMail: alan.d.clark@telchemy.com


   Alan Johnston
   Avaya
   St. Louis, MO  63124
   EMail: alan.b.johnston@gmail.com


   Henry Sinnreich
   Unaffiliated
   EMail: henry.sinnreich@gmail.com





Pendleton, et al.            Standards Track                   [Page 41]
^L