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 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029
|
<pre>Internet Engineering Task Force (IETF) A. Johnston, Ed.
Request for Comments: 7463 Avaya
Updates: <a href="./rfc3261">3261</a>, <a href="./rfc4235">4235</a> M. Soroushnejad, Ed.
Category: Standards Track V. Venkataramanan
ISSN: 2070-1721 Sylantro Systems Corp.
March 2015
<span class="h1">Shared Appearances of a Session Initiation Protocol (SIP)</span>
<span class="h1">Address of Record (AOR)</span>
Abstract
This document describes the requirements and implementation of a
group telephony feature commonly known as Bridged Line Appearance
(BLA) or Multiple Line Appearance (MLA), or Shared Call/Line
Appearance (SCA). When implemented using the Session Initiation
Protocol (SIP), it is referred to as shared appearances of an Address
of Record (AOR) since SIP does not have the concept of lines. This
feature is commonly offered in IP Centrex services and IP Private
Branch Exchange (IPBX) offerings and is likely to be implemented on
SIP IP telephones and SIP feature servers used in a business
environment. This feature allows several user agents (UAs) to share
a common AOR, learn about calls placed and received by other UAs in
the group, and pick up or join calls within the group. This document
discusses use cases, lists requirements, and defines extensions to
implement this feature. This specification updates RFCs 3261 and
4235.
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 <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc7463">http://www.rfc-editor.org/info/rfc7463</a>.
Copyright Notice
Copyright (c) 2015 IETF Trust and the persons identified as the
document authors. All rights reserved.
<span class="grey">Johnston, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) 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.
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-2">2</a>. Conventions Used in This Document . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-3">3</a>. Usage Scenarios . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-3.1">3.1</a>. Executive/Assistant Arrangement . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-3.2">3.2</a>. Call Group . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-3.3">3.3</a>. Single Line Extension . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-3.4">3.4</a>. Changing UAs . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-4">4</a>. Requirements and Implementation . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-4.1">4.1</a>. Requirements . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-4.2">4.2</a>. Implementation . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-5">5</a>. Normative Description . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-5.1">5.1</a>. Elements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-5.2">5.2</a>. Shared Appearance Dialog Package Extensions . . . . . . . <a href="#page-11">11</a>
<a href="#section-5.2.1">5.2.1</a>. The <appearance> Element . . . . . . . . . . . . . . <a href="#page-11">11</a>
<a href="#section-5.2.2">5.2.2</a>. The <exclusive> Element . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-5.2.3">5.2.3</a>. The <joined-dialog> Element . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-5.2.4">5.2.4</a>. The <replaced-dialog> Element . . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-5.3">5.3</a>. Shared Appearance User Agents . . . . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-5.3.1">5.3.1</a>. Appearance Numbers and Call Context . . . . . . . . . <a href="#page-16">16</a>
<a href="#section-5.3.2">5.3.2</a>. Appearance Numbers and Call Control . . . . . . . . . <a href="#page-17">17</a>
<a href="#section-5.3.3">5.3.3</a>. Appearance Numbers and Transfer . . . . . . . . . . . <a href="#page-18">18</a>
<a href="#section-5.4">5.4</a>. Appearance Agent . . . . . . . . . . . . . . . . . . . . <a href="#page-18">18</a>
<a href="#section-6">6</a>. XML Schema Definition . . . . . . . . . . . . . . . . . . . . <a href="#page-21">21</a>
<a href="#section-7">7</a>. Alert-Info Appearance Parameter Definition . . . . . . . . . <a href="#page-23">23</a>
<span class="grey">Johnston, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<a href="#section-8">8</a>. User Interface Considerations . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
<a href="#section-8.1">8.1</a>. Appearance Number Rendering . . . . . . . . . . . . . . . <a href="#page-24">24</a>
<a href="#section-8.1.1">8.1.1</a>. Single Appearance UAs . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
<a href="#section-8.1.2">8.1.2</a>. Dual Appearance UAs . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
8.1.3. Shared Appearance UAs with Fixed Appearance Number . 25
8.1.4. Shared Appearance UAs with Variable Appearance
Numbers . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-25">25</a>
<a href="#section-8.1.5">8.1.5</a>. Example User Interface Issues . . . . . . . . . . . . <a href="#page-25">25</a>
<a href="#section-8.2">8.2</a>. Call State Rendering . . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
<a href="#section-9">9</a>. Interoperability with Non-shared Appearance UAs . . . . . . . <a href="#page-26">26</a>
<a href="#section-9.1">9.1</a>. Appearance Assignment . . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
<a href="#section-9.2">9.2</a>. Appearance Release . . . . . . . . . . . . . . . . . . . <a href="#page-27">27</a>
9.3. UAs Supporting Dialog Events but Not Shared Appearance . 27
<a href="#section-10">10</a>. Provisioning Considerations . . . . . . . . . . . . . . . . . <a href="#page-27">27</a>
<a href="#section-11">11</a>. Example Message Flows . . . . . . . . . . . . . . . . . . . . <a href="#page-28">28</a>
<a href="#section-11.1">11.1</a>. Registration and Subscription . . . . . . . . . . . . . <a href="#page-28">28</a>
<a href="#section-11.2">11.2</a>. Appearance Selection for Incoming Call . . . . . . . . . <a href="#page-32">32</a>
<a href="#section-11.3">11.3</a>. Outgoing Call without Appearance Seizure . . . . . . . . <a href="#page-35">35</a>
<a href="#section-11.4">11.4</a>. Outgoing Call with Appearance Seizure . . . . . . . . . <a href="#page-38">38</a>
<a href="#section-11.5">11.5</a>. Outgoing Call without Using an Appearance Number . . . . <a href="#page-42">42</a>
<a href="#section-11.6">11.6</a>. Appearance Release . . . . . . . . . . . . . . . . . . . <a href="#page-44">44</a>
<a href="#section-11.7">11.7</a>. Appearance Pickup . . . . . . . . . . . . . . . . . . . <a href="#page-45">45</a>
<a href="#section-11.8">11.8</a>. Call between UAs within the Group . . . . . . . . . . . <a href="#page-50">50</a>
<a href="#section-11.9">11.9</a>. Consultation Hold with Appearances . . . . . . . . . . . <a href="#page-52">52</a>
<a href="#section-11.10">11.10</a>. Joining or Bridging an Appearance . . . . . . . . . . . <a href="#page-55">55</a>
<a href="#section-11.11">11.11</a>. Loss of Appearance during Allocation . . . . . . . . . . <a href="#page-58">58</a>
<a href="#section-11.12">11.12</a>. Appearance Seizure Contention Race Condition . . . . . . <a href="#page-59">59</a>
<a href="#section-11.13">11.13</a>. Appearance Agent Subscription to UAs . . . . . . . . . . <a href="#page-60">60</a>
<a href="#section-11.14">11.14</a>. Appearance Pickup Race Condition Failure . . . . . . . . <a href="#page-62">62</a>
11.15. Appearance Seizure Incoming/Outgoing Contention Race
Condition . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-65">65</a>
<a href="#section-12">12</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-66">66</a>
<a href="#section-13">13</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-67">67</a>
<a href="#section-13.1">13.1</a>. SIP Event Header Field Parameter: shared . . . . . . . . <a href="#page-67">67</a>
<a href="#section-13.2">13.2</a>. SIP Alert-Info Header Field Parameter: appearance . . . <a href="#page-68">68</a>
<a href="#section-13.3">13.3</a>. URN Sub-Namespace Registration: sa-dialog-info . . . . . <a href="#page-68">68</a>
<a href="#section-13.4">13.4</a>. XML Schema Registration . . . . . . . . . . . . . . . . <a href="#page-68">68</a>
<a href="#section-14">14</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-69">69</a>
<a href="#section-14.1">14.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-69">69</a>
<a href="#section-14.2">14.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-70">70</a>
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-71">71</a>
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-71">71</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
The feature and functionality requirements for SIP user agents (UAs)
supporting business telephony applications differ greatly from basic
SIP UAs, both in terms of services and end-user experience. In
<span class="grey">Johnston, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
addition to basic SIP support [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>], many of the services in a
business environment require the support for SIP extensions such as
REFER [<a href="./rfc3515" title=""The Session Initiation Protocol (SIP) Refer Method"">RFC3515</a>], SUBSCRIBE/NOTIFY [<a href="./rfc6665" title=""SIP-Specific Event Notification"">RFC6665</a>], PUBLISH [<a href="./rfc3903" title=""Session Initiation Protocol (SIP) Extension for Event State Publication"">RFC3903</a>], the
SIP Replaces [<a href="./rfc3891" title=""The Session Initiation Protocol (SIP) "">RFC3891</a>], and Join [<a href="./rfc3911" title=""The Session Initiation Protocol (SIP) "">RFC3911</a>] header fields, etc. Many
of the popular business services have been documented in the SIP
Service Examples [<a href="./rfc5359" title=""Session Initiation Protocol Service Examples"">RFC5359</a>].
This specification details a method for implementing a group
telephony feature known variously in telephony as Bridged Line
Appearance (BLA) or Multiple Line Appearances (MLA), one of the more
popular advanced features expected of SIP IP telephony devices in a
business environment. Other names for this feature include Shared
Call/Line Appearance (SCA), Shared Call Status and Multiple Call
Appearance (MCA). A variant of this feature is known as Single Line
Extension.
This document looks at how this feature can be implemented using
standard SIP [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] in conjunction with SIP events [<a href="./rfc6665" title=""SIP-Specific Event Notification"">RFC6665</a>] and
publication [<a href="./rfc3903" title=""Session Initiation Protocol (SIP) Extension for Event State Publication"">RFC3903</a>] (carrying the SIP dialog state event package
[<a href="./rfc4235" title=""An INVITE- Initiated Dialog Event Package for the Session Initiation Protocol (SIP)"">RFC4235</a>]) for exchanging status among UAs.
In traditional telephony, the line is physical. A common scenario in
telephony is for a number of business telephones to share a single or
a small number of lines. The sharing or appearance of these lines
between a number of phones is what gives this feature its name. A
common scenario in SIP is for a number of business telephones to
share a single or a small number of Address of Record (AOR) URIs.
In addition, an AOR can have multiple appearances on a single UA in
terms of the user interface. The appearance number relates to the
user interface for the telephone; typically, each appearance of an
AOR has a visual display (lamp that can change color or blink or a
screen icon) and a button (used to select the appearance) where each
appearance number is associated with a different dialog to/from the
AOR. The telephony concept of line appearance is still relevant to
SIP due to the user interface considerations. It is important to
keep the appearance number construct because:
1. Human users are used to the concept and will expect it in
replacement systems (e.g., an overhead page announcement says
"Joe pickup line 3").
2. It is a useful structure for user interface representation.
The purpose of the appearance number is to identify active calls to
facilitate sharing between users (e.g., passing a call from one user
to another). If a telephone has enough buttons/lamps, the appearance
number could be the positional sequence number of the button. If
<span class="grey">Johnston, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
not, it may still be desirable to present the call state, but the
appearance number should be displayed so that users know which call,
for example, is on hold on which key.
In this document, except for the usage scenarios in the next section,
we will use the term "appearance" rather than "line appearance" since
SIP does not have the concept of lines. Note that this does not mean
that a conventional telephony user interface (lamps and buttons) must
be used: implementations may use another metaphor as long as the
appearance number is readily apparent to the user. Each AOR has a
separate appearance numbering space. As a result, a given UA user
interface may have multiple occurrences of the same appearance
number, but they will be for different AORs.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Conventions Used in This Document</span>
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 <a href="./rfc2119">RFC 2119</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>]
and indicate requirement levels for compliant mechanisms.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Usage Scenarios</span>
The following examples are common applications of the shared
appearances feature and are mentioned here as informative use cases.
All these example usages can be supported by the shared appearances
feature described in this document. The main differences relate to
the user interface considerations of the device.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Executive/Assistant Arrangement</span>
The appearances on the executive's UA also appear on the assistant's
UA. The assistant may answer incoming calls to the executive and
then place the call on hold for the executive to pick up. The
assistant can always see the state of all calls on the executive's
UA.
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Call Group</span>
Users with similar business needs or tasks can be assigned to
specific groups and share an AOR. For example, an IT department
staff of five might answer a help line that has three appearances on
each phone in the IT work area. A call answered on one phone can be
put on hold and picked up on another phone. A shout or an IM to
another staff member can result in them taking over a call on a
particular appearance. Another phone can request to be added/joined/
bridged to an existing appearance resulting in a conference call.
<span class="grey">Johnston, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Single Line Extension</span>
In this scenario, incoming calls are offered to a group of UAs. When
one answers, the other UAs are informed. If another UA in the group
seizes the line (i.e., goes off-hook), it is immediately bridged or
joined in with the call. This mimics the way residential telephone
extensions usually operate.
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. Changing UAs</span>
A user is on a call on one UA and wishes to change devices and
continue the call on another UA. They place the call on hold, note
the appearance number of the call, then walk to another UA. They are
able to identify the same appearance number on the other UA, pick up
the call, and continue the conversation.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Requirements and Implementation</span>
The next section details the requirements and discusses the
implementation of the shared appearances feature.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Requirements</span>
The basic requirements of the shared appearances feature can be
summarized as follows:
REQ-1: Incoming calls to the AOR must be offered to a group of UAs
and can be answered by any of them.
REQ-2: Each UA in the group must be able to learn the call status
of the others in the group for the purpose of rendering this
information to the user.
REQ-3: A UA must be able to join (also called bridge or conference
together) or pick up (take) an active call of another UA in
the group in a secure way.
REQ-4: The mechanism should require the minimal amount of
configuration. UAs registering against the group AOR should
be able to participate in the shared appearance group
without manual configuration of group members.
REQ-5: The mechanism must scale for large numbers of appearances
and large numbers of UAs without introducing excessive
messaging traffic.
REQ-6: Each call or session (incoming or outgoing) should be
assigned a common "appearance" number from a managed pool
<span class="grey">Johnston, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
administered for the AOR group. Once the session has
terminated, the appearance number is released back into the
pool and can be reused by another incoming or outgoing
session.
REQ-7: Each UA in the group must be able to learn the status of all
appearances of the group.
REQ-8: There must be mechanisms to resolve appearance contention
among the UAs in the group. Contention in this context
means an appearance number being associated with multiple
dialogs that are not mixed or otherwise associated.
REQ-9: The mechanism must allow all UAs receiving an incoming
session request to utilize the same appearance number at the
time of alerting.
REQ-10: The mechanism must have a way of reconstructing appearance
state after an outage that does not result in excessive
traffic and processing.
REQ-11: The mechanism must have backwards compatibility such that a
UA that is unaware of the feature can still register against
the group AOR and make and receive calls.
REQ-12: The mechanism must not allow UAs outside the group to
select, seize, or manipulate appearance numbers.
REQ-13: For privacy reasons, there must be a mechanism so that
appearance information is not leaked outside the group of
UAs (e.g., "So who do you have on line 1?").
REQ-14: The mechanism must support a way for UAs to request
exclusivity on a line appearance. Exclusivity means that
the UA requesting it desires a private conversation with the
external party and other UAs must not be allowed to join or
take the call. Exclusivity may be requested at the start of
an incoming or outgoing session or during the session. An
exclusivity request may be accepted or rejected by the
entity providing the shared appearance service. Therefore,
the mechanism must provide a way of communicating the result
back to the requester UA.
REQ-15: The mechanism should support a way for a UA to seize a
particular appearance number for outgoing requests prior to
sending the actual request. This is often called seizure.
<span class="grey">Johnston, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
REQ-16: The mechanism should support a way for a UA to seize a
particular appearance number and also send the request at
the same time. This is needed when an automatic ringdown
feature (a telephone configured to immediately dial a phone
number when it goes off-hook) is combined with shared
appearances. In this case, seizing the line is integrated
with dialing.
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Implementation</span>
This section non-normatively discusses the implementation of the
shared appearances feature. The normative description is in
<a href="#section-5">Section 5</a>. Many of the requirements for this service can be met
using standard SIP mechanisms such as:
o A SIP Forking Proxy and Registrar/Location Service meets REQ-1.
o The SIP Dialog Package meets REQ-2.
o The combination of the SIP Replaces and Join header fields meets
REQ-3.
o The use of a State Agent for the Dialog Package meets REQ-4 and
REQ-5.
REQ-6 suggests the need for an entity that manages the appearance
resource. Just as conferencing systems commonly have a single point
of control, known as a focus, a shared appearance group has a single
point of control of the appearance shared resource. This is defined
as an Appearance Agent for a group. While an Appearance Agent can be
part of a centralized server, it could also be co-resident in a
member UA that has taken on this functionality for a group. The
Appearance Agent knows or is able to determine the dialog state of
all members of the group.
While the appearance resource could be managed cooperatively by a
group of UAs without any central control, this is outside the scope
of this document. It is also possible that the Appearance Agent
logic could be distributed in all UAs in the group. For example,
rules that govern assigning appearance numbers for incoming requests
(e.g., lowest available appearance number) and rules for contention
handling (e.g., when two UAs request the use of the same appearance
number, hash dialog identifiers and compare with the lowest hash
winning) would need to be defined and implemented.
To best meet REQ-9, the appearance number for an incoming INVITE
needs to be contained in the INVITE, in addition to being delivered
in the dialog package NOTIFY. Otherwise, if the NOTIFY is delayed or
<span class="grey">Johnston, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
lost, a UA in the group might receive an incoming INVITE but might
not know which appearance number to render during alerting.
This specification defines an extension parameter, which is
normatively defined in <a href="#section-7">Section 7</a>, for the Alert-Info header field in
<a href="./rfc3261">RFC 3261</a> to carry the appearance number:
Alert-Info: <urn:alert:service:normal>;appearance=1
The following list describes the operation of the shared appearances
feature.
1. A UA is configured with the AOR of a shared appearance group. It
registers against the AOR, then attempts a dialog state
subscription to the AOR. If the subscription fails, loops back
to itself, or returns an error, it knows there is no State Agent
and, hence, no Appearance Agent and this feature is not
implemented.
2. If the subscription receives a 200 OK, the UA knows there is a
State Agent and that the feature is implemented. The UA then
follows the steps in this list.
3. Information learned about the dialog state of other UAs in the
group is rendered to the user.
4. Incoming calls are forked to all UAs in the group, and any may
answer. UAs receive the appearance number to use in rendering
the incoming call in a NOTIFY from the Appearance Agent and in
the INVITE itself. The UA will also receive a notification if
the call is answered by another UA in the group so this
information can be rendered to the user.
5. For outgoing calls, the operation depends on the implementation.
If the user seizes a particular appearance number for the call,
the UA publishes the trying state dialog information with the
desired appearance number and waits for a 2xx response before
sending the INVITE.
6. For outgoing calls, if the user does not seize a particular
appearance or does not care, the INVITE can be sent immediately,
and the appearance number learned as the call progresses from a
notification from the Appearance Agent.
7. For outgoing calls, if the user does not want an appearance
number assigned (such as during a consultation call or if a UA is
fetching 'service media' such as music on hold [<a href="./rfc7088" title=""Session Initiation Protocol Service Example -- Music on Hold"">RFC7088</a>]), the UA
<span class="grey">Johnston, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
also publishes prior to sending the INVITE but does not include
an appearance number in the publication.
8. Established calls within the group may be joined (bridged) or
taken (picked) by another UA. Information in the dialog package
notifications can be used to construct Join or Replaces header
fields. Since the same appearance number is used for these types
of operations, this information is published prior to sending the
INVITE Join or INVITE Replaces.
9. The Appearance Agent may not have direct access to the complete
dialog state of some or all of the UAs in the group. If this is
the case, the Appearance Agent will subscribe to the dialog state
of individual UAs in the group to obtain this information. In
any case, the Appearance Agent will send normal notifications
(via the subscriptions established by the UAs in step 1) every
time the aggregate dialog state of the AOR changes, including
when calls are placed, answered, placed on and off hold, and hung
up.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Normative Description</span>
This section normatively describes the shared appearances feature
extensions. The following definitions are used throughout this
document:
Appearance number: An appearance number is a positive integer
associated with one or more dialogs of an AOR. Appearance numbers
are managed by an Appearance Agent and displayed and rendered to
the user by UAs that support this specification. When an
appearance number is assigned or requested, generally the assigned
number is the smallest positive integer that is not currently
assigned as an appearance number to a dialog for this AOR. This
specification does not define an upper limit on appearance
numbers; however, using appearance numbers that are not easily
represented using common integer representations is likely to
cause failures.
Seizing: An appearance can be reserved prior to a call being placed
by seizing the appearance. An appearance can be seized by
communicating an artificial state of "trying" prior to actually
initiating a dialog (i.e., sending the INVITE), in order to appear
as if it were already initiating a dialog.
Selecting (or Not-Seizing): An appearance is merely selected (i.e.,
not seized) if there is no such communication of artificial state
of "trying" prior to initiating a dialog: i.e., the state is
<span class="grey">Johnston, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
communicated when the dialog is actually initiated. The
appearance number is learned after the INVITE is sent.
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Elements</span>
A complete system to implement this feature consists of:
1. UAs that support publications, subscriptions, and notifications
for the SIP dialog event package and the shared appearance dialog
package extensions and behavior.
2. An Appearance Agent consisting of a State Agent for the dialog
event package that implements an Event State Compositor (ESC) and
the shared appearance dialog package extensions and behavior.
The Appearance Agent also has logic for assigning and releasing
appearance numbers and resolving appearance number contention.
3. A forking proxy server that can communicate with the State Agent.
4. A registrar that supports the registration event package.
The behavior of these elements is described normatively in the
following sections after the definitions of the dialog package
extensions.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Shared Appearance Dialog Package Extensions</span>
This specification defines four new elements as extensions to the SIP
Dialog Event package [<a href="./rfc4235" title=""An INVITE- Initiated Dialog Event Package for the Session Initiation Protocol (SIP)"">RFC4235</a>]. The schema is defined in <a href="#section-6">Section 6</a>.
The elements are <appearance>, <exclusive>, <joined-dialog>, and
<replaced-dialog>, which are sub-elements of the <dialog> element.
<span class="h4"><a class="selflink" id="section-5.2.1" href="#section-5.2.1">5.2.1</a>. The <appearance> Element</span>
The <appearance> element, a child of the <dialog> element, is used to
convey the appearance number of the dialog described by the parent
<dialog> element. When sent by a UA in a PUBLISH with parent
<dialog> with state attribute "trying" to the Appearance Agent, the
UA is requesting assignment of the given appearance number to the
current or future dialog with the given dialog identifiers. When an
<appearance> element is sent by the Appearance Agent in a NOTIFY, it
indicates that the appearance number has been assigned to the
specified dialog.
Note that a <dialog-info> element describes the contained dialogs
from the point of view of the UA (named by the "entity" attribute),
regardless of whether the containing request is sent by the UA or the
Appearance Agent. In particular, if the UA sent a request within the
<span class="grey">Johnston, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
described dialog, the To header field URI would match the <remote>
<identity> value and the to-tag parameter would match the remote-tag
attribute. Similarly, the From header field URI would match the
<local> <identity> value and the from-tag parameter would match the
local-tag attribute.
<span class="h4"><a class="selflink" id="section-5.2.2" href="#section-5.2.2">5.2.2</a>. The <exclusive> Element</span>
The <exclusive> element, a child of the <dialog> element, is a
boolean, which, when true, indicates that the UA is not willing to
accept an INVITE with a Join or Replaces header field targeted to the
dialog described by the <dialog> element that is the parent of the
<exclusive> element. For example, some shared appearance systems
only allow call pickup when the call is on hold. In this case, the
<exclusive> element should be set to "false" when the call is held
and "true" when the call is not held, rather than having the
"exclusive" value implied by the hold state.
It is important to note that this element is a hint. In order to
prevent another UA from taking or joining a call, a UA can, in
addition to setting the <exclusive> tag, not report full dialog
information to the Appearance Agent. Not having the full dialog
information (Call-ID, remote-tag, and local-tag) prevents another UA
from constructing a Join or Replaces header field. Although a UA may
set <exclusive> to "true", the UA must still be ready to reject an
INVITE Join relating to this dialog. If these dialog identifiers
have already been shared with the Appearance Agent, the UA could send
an INVITE Replaces to change them and then not report the new ones to
the Appearance Agent.
If the proxy knows which dialogs are marked exclusive, the proxy MAY
enforce this exclusivity by rejecting INVITE Join and INVITE Replaces
requests containing those dialog identifiers with a 403 (Forbidden)
response.
Note that exclusivity has nothing to do with appearance number
selection or seizing -- instead, it is about call control
operations that can be performed on a dialog.
If the <exclusive> element is not present, it is assumed to be false.
<span class="h4"><a class="selflink" id="section-5.2.3" href="#section-5.2.3">5.2.3</a>. The <joined-dialog> Element</span>
The <joined-dialog> element, a child of the <dialog> element, is used
to convey dialog identifiers of any other dialogs that are joined
(mixed or bridged) with the dialog. Only the UA that is the common
endpoint of the mixed dialogs (and thus controlling the mixing
operation) should include this element in publications to the
<span class="grey">Johnston, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Appearance Agent. Note that this element should still be used even
when the Join header field was not used to join the dialogs. For
example, two separate dialogs on a UA could be joined without any SIP
call control operations. Joined dialogs will share the same
appearance number.
If the <joined-dialog> element is not present, it is assumed that the
dialog is not joined or to be joined to any other dialog.
<span class="h4"><a class="selflink" id="section-5.2.4" href="#section-5.2.4">5.2.4</a>. The <replaced-dialog> Element</span>
The <replaced-dialog> element, a child of the <dialog> element, is
used to convey dialog identifiers of any other dialogs that will be
or have been replaced with this dialog. For example, a UA in the
group picking up a call on another UA by sending an INVITE with
Replaces would include this element for the replacing dialog.
Replaced dialogs will share the same appearance number.
If the <replaced-dialog> element is not present, it is assumed that
the dialog has not replaced or is not to replace to any other dialog.
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Shared Appearance User Agents</span>
UAs that support the shared appearances feature use the dialog state
package [<a href="./rfc4235" title=""An INVITE- Initiated Dialog Event Package for the Session Initiation Protocol (SIP)"">RFC4235</a>] with the shared appearance extensions and the
'shared' Event header field parameter defined in <a href="#section-13">Section 13</a>.
UAs use the dialog package extensions in <a href="#section-5.2">Section 5.2</a> along with
SUBSCRIBE [<a href="./rfc6665" title=""SIP-Specific Event Notification"">RFC6665</a>], NOTIFY [<a href="./rfc6665" title=""SIP-Specific Event Notification"">RFC6665</a>], and PUBLISH [<a href="./rfc3903" title=""Session Initiation Protocol (SIP) Extension for Event State Publication"">RFC3903</a>].
SUBSCRIBE, NOTIFY, and PUBLISH requests for the dialog event package
include the 'shared' Event header field parameter as required by this
specification.
The presence of the 'shared' Event header field parameter tells
the Appearance Agent that the UA supports this specification.
Upon initialization, the UA MUST subscribe to the dialog event
package of the AOR and refresh the subscription per the SIP Events
Framework [<a href="./rfc6665" title=""SIP-Specific Event Notification"">RFC6665</a>]. If the SUBSCRIBE request fails, then no
Appearance Agent may be present and this feature is not active for
this AOR. The UA MAY periodically retry the subscription to see if
conditions have changed at intervals no shorter than four hours.
Four hours was chosen to limit the subscription test to six per
day per UA. Increasing this interval would reduce this failure
traffic but take longer for a newly activated Appearance Agent to
be discovered.
<span class="grey">Johnston, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
UAs can also use the presence of the 'shared' Event header field
parameter in NOTIFYs to discover the presence of an Appearance Agent
for the AOR.
UAs that implement the shared appearances feature, call pickup,
joining, and bridging MUST support sending an INVITE with Replaces
[<a href="./rfc3891" title=""The Session Initiation Protocol (SIP) "">RFC3891</a>] or Join [<a href="./rfc3911" title=""The Session Initiation Protocol (SIP) "">RFC3911</a>]. The User Agent Client (UAC) needs to
include the to-tag and from-tag information in the Replaces or Join
header so that the correct dialog will be matched by the User Agent
Server (UAS) per the rules in RFCs 3891 and 3911.
All UAs that implement the shared appearances feature and support
INVITE MUST support receiving an INVITE with a Replaces [<a href="./rfc3891" title=""The Session Initiation Protocol (SIP) "">RFC3891</a>] or
a Join [<a href="./rfc3911" title=""The Session Initiation Protocol (SIP) "">RFC3911</a>] header field.
When publishing or notifying dialog package information, a UA
includes the largest set of dialog identification available at the
time of publication, with the exception that a UA may omit
information if it wishes to prevent other UAs from joining or picking
up a call. Dialog identification includes local and remote target
URIs, call-id, to-tag, and from-tag. While this dialog
identification information is optional in [<a href="./rfc4235" title=""An INVITE- Initiated Dialog Event Package for the Session Initiation Protocol (SIP)"">RFC4235</a>], it is essential
in the shared appearances feature, allowing call control operations.
When placing calls on hold, use the "+sip.rendering=no" feature tag
to indicate this in dialog package notifications. Using the full SDP
session description instead forces the endpoint to do a lot of extra
parsing, unnecessarily complicating the code and inviting errors.
The accurate rendering of the idle/active/alerting/hold state of
other UAs in the group is an important part of the shared
appearances feature.
A UA that does not need to seize a particular appearance number (or
doesn't care) would just send an INVITE as normal to place an
outbound call.
If the call is an emergency call, a UA MUST never wait for a
confirmed seizure before sending an INVITE. Instead, the emergency
call MUST proceed without waiting for the PUBLISH transaction.
If a UA requires a particular appearance number, the a UA MUST send a
dialog package PUBLISH request and wait for a 2xx response before
sending the INVITE. This is required in the following situations:
1. When the user seizes a particular appearance number for an
outgoing call (e.g., seizing the appearance and going "off-hook",
if the UA's user interface uses this metaphor).
<span class="grey">Johnston, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
2. When the user has requested that an appearance number not be used
for an outgoing call (i.e., during a consultation call, a
'service media' call such as for music on hold [<a href="./rfc7088" title=""Session Initiation Protocol Service Example -- Music on Hold"">RFC7088</a>], or for
a call not considered part of the shared appearance group).
3. When the user has selected to join (or bridge) an existing call.
4. When the user has selected to replace (or take) an existing call.
Note that when a UA seizes an appearance prior to establishment of a
dialog (numbers 1 and 2 in the above list), not all dialog
information will be available. In particular, when a UA publishes an
attempt to seize an appearance prior to knowing the destination URI,
minimal or no dialog information may be available. For example, in
some cases, only the local target URI for the call will be known: not
any dialog information. If the From tag and Call-ID were not present
in the initial PUBLISH, a new PUBLISH MUST be sent as soon as this
information is available.
The first publication will cause the Appearance Agent to reserve
the appearance number for this UA. If the publication does not
have any dialog identifiers (e.g., Call-ID or local-tag), the
Appearance Agent cannot assign the appearance number to a
particular dialog of the UA until the second publication, which
will contain some dialog identifiers.
This publication state is refreshed as described in [<a href="./rfc3903" title=""Session Initiation Protocol (SIP) Extension for Event State Publication"">RFC3903</a>] during
the early dialog state or the Appearance Agent may reassign the
appearance number. Once the dialog has transitioned to the confirmed
state, no publication refreshes are necessary.
This specification assumes that the Appearance Agent has other
means besides UA publication to learn about the state of UA
dialogs. In this specification, PUBLISH is used to indicate
desired and intended appearance number operations. Once a dialog
transitions from early to confirmed, this role is over; hence, no
publication refreshes are needed.
Appearance numbers are a shorthand label for active and pending
dialogs related to an AOR. Many of the features and services built
using this extension rely on the correct rendering of this
information to the human user. In addition, the group nature of the
feature means that the rendering must be similar between different
vendors and different models. Failure to do so will greatly reduce
the value and usefulness of these protocol extensions. In a
correctly designed user interface for this feature, the appearances
number for each active and pending dialog is explicitly (i.e., by
appearance number) or implicitly (using a user interface metaphor
<span class="grey">Johnston, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
that makes the numbering and ordering clear to the user) rendered to
the user. The far-end identity of each dialog (e.g., the remote
party identity) is not a useful replacement for the appearance
number. The state of each appearance is also to be rendered (idle,
active, busy, joined, etc.). UAs can tell that a set of dialogs are
joined (bridged or mixed) together by the presence of one or more
<joined-dialog> elements containing other SIP dialog identifiers.
Appearance numbers of dialogs can be learned by dialog package
notifications containing the <appearance> element from the Appearance
Agent or from the 'appearance' Alert-Info parameter in an incoming
INVITE. Should they conflict, the dialog package notification takes
precedence.
A user may select an appearance number but then abandon placing a
call (go back on-hook). In this case, the UA frees up the appearance
number by removing the event state with a PUBLISH as described in
[<a href="./rfc3903" title=""Session Initiation Protocol (SIP) Extension for Event State Publication"">RFC3903</a>]. A failure to do this will require unnecessary operations
by the Appearance Agent and tie up appearance numbers that could
otherwise be used by other UAs in the shared appearance group.
A UA SHOULD register against the AOR only if it is likely the UA will
be answering incoming calls. If the UA is mainly going to be
monitoring the status of the shared appearance group calls and
picking or joining calls, the UA SHOULD only subscribe to the AOR and
not register against the AOR. If a monitoring UA registers rather
than just subscribing, it generates large amounts of unnecessary
network traffic.
All subscribed UAs will receive dialog package NOTIFYs of trying
state for incoming INVITEs.
A UA MUST NOT insert an 'appearance' parameter into an Alert-Info
header field in an INVITE or other request.
The Appearance Agent is solely responsible for doing this.
<span class="h4"><a class="selflink" id="section-5.3.1" href="#section-5.3.1">5.3.1</a>. Appearance Numbers and Call Context</span>
There are cases where two separate dialogs at a UA are not mixed but
share the same 'context'. That is, they relate to each other and
should not be treated the same as any other two dialogs within the
group. One example of this is a 'consultation call' where a user
puts an existing dialog on hold, then calls another user, before
switching back to the original dialog. Another case, described
below, occurs during transfer operations, where for a transient
period, a UA is involved in dialogs with two other UAs, but the
dialogs are related, and should not be treated as independent
dialogs. These cases are best handled by not assigning an appearance
<span class="grey">Johnston, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
number to a newly created dialog when it shares a context with an
existing dialog. But if the preexisting dialog is terminated, its
appearance number should be reassigned to the newly created dialog.
A UA that wants to place a call but does not have an appearance
number assigned sends a PUBLISH before sending the INVITE. The
PUBLISH does not have an 'appearance' element present, but it does
have the 'shared' Event header field parameter present. If the
Appearance Agent policy does not allow calls without an assigned
appearance number, a 400 (Bad Request) response is sent by the
Appearance Agent and the UA will republish either selecting/seizing
an appearance number or send the INVITE without publishing, in which
case the Appearance Agent will assign one.
Note that if an Appearance Agent rejects calls without an
appearance number, certain operations such as consultation calls,
transfer, and music on hold may be negatively impacted.
<span class="h4"><a class="selflink" id="section-5.3.2" href="#section-5.3.2">5.3.2</a>. Appearance Numbers and Call Control</span>
When an INVITE is generated to attempt to bridge or take a call
(i.e., contains Join or Replaces with a dialog identifier of another
dialog in the shared appearance group), the UA MUST first send a
PUBLISH to the Appearance Agent. This PUBLISH will contain:
1. The appearance number of the joined or replaced call in the
<appearance> element
2. The dialog information from the Join header field in the <joined-
dialog> element, if the dialog is being joined
3. The dialog information from the Replaces header field in the
<replaced-dialog> element, if the dialog is being replaced
Note that this information is provided to the Appearance Agent so
that it can provide proper appearance assignment behavior. If the
INVITE Join or Replaces was sent without publishing first, the
Appearance Agent might assign a new appearance number to this
INVITE, which would be a mistake. With Join, the publication has
the <joined-dialog> element to prevent the Appearance Agent from
generating a 400 (Bad Request) response due to the reuse of an
appearance number. For Replaces, the purpose of the <replaced-
dialog> is to prevent a race condition where the BYE could cause
the appearance number to be released when it should stay with the
replacing dialog.
<span class="grey">Johnston, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h4"><a class="selflink" id="section-5.3.3" href="#section-5.3.3">5.3.3</a>. Appearance Numbers and Transfer</span>
During a transfer operation, it is important that the appearance
number not change during the operation. Consider the example of
Alice, a member of a shared appearance group, who is talking to
Carol, who is outside the shared appearance group. Carol transfers
Alice to David, who is also outside the shared appearance group. For
example, if Alice is using appearance 3 for the session with Carol,
the resulting session with David should also use appearance number 3.
Otherwise, an appearance number change can cause a "jump" on the UI
and confusion to the user. There are two possible scenarios using
the terminology of <a href="./rfc5589">RFC 5589</a>: Alice is the transferee in any type of
transfer (receives the REFER) or the transfer target in an attended
transfer (receives the INVITE with Replaces).
If Alice is the transferee, the triggered INVITE from the REFER is
treated as a consultation call. Alice SHOULD publish requesting that
the Appearance Agent not assign an appearance number for this INVITE.
When the transfer completes, Alice SHOULD publish again to move the
appearance number from the dialog with Carol to the dialog with
David. If a PUBLISH is sent to move the appearance number, the
publication MUST be sent prior to sending the BYE to Carol to avoid a
race condition where the Appearance Agent reassigns the appearance
number after seeing the BYE.
If Alice is the target, the incoming INVITE will contain a Replaces
header field. As a result, the Appearance Agent will have reused the
appearance number of the dialog with Carol, and this appearance
number will continue to be used after the dialog with Carol has been
terminated.
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. Appearance Agent</span>
An Appearance Agent defined in this specification MUST implement a
dialog package state agent for the UAs registered against the AOR.
The Appearance Agent MUST support the appearance dialog package
extensions defined in <a href="#section-5.2">Section 5.2</a> and use the 'shared' Event header
field parameter. The Appearance Agent MUST support publications and
subscriptions for this event package.
The Appearance Agent MUST have a way of discovering the state of all
dialogs associated with the AOR. If this information is not
available from a call stateful proxy or Back-to-Back User Agent
(B2BUA), the Appearance Agent can use the registration event package
[<a href="./rfc3680" title=""A Session Initiation Protocol (SIP) Event Package for Registrations"">RFC3680</a>] to learn of UAs associated with the AOR and subscribe to
their dialog event state. An Appearance Agent can also subscribe to
a UA's dialog event state in order to reconstruct state. As a
result, the registrar MUST support the registration event package.
<span class="grey">Johnston, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Dialog package notifications are recommended by <a href="./rfc4235">RFC 4235</a> to "only
contain information on the dialogs whose state or participation
information has changed." This specification extends <a href="./rfc4235">RFC 4235</a> as
follows. The Appearance Agent SHOULD send dialog event state
notifications whenever the following events happen to UAs in the AOR
group:
1. A call is received, placed, answered, or terminated.
2. A call is placed on or off hold.
3. A call is joined or replaced.
4. An appearance number is reserved or released.
The Appearance Agent MUST allocate an appearance number for all
incoming calls and send immediate notifications to the UAs subscribed
to the shared group AOR. A new appearance number is allocated except
for an incoming INVITE with a Join or Replaces header field. For
this case, the appearance number should match the appearance number
of the dialog being joined or replaced. If the INVITE Replaces or
Join comes from outside the shared appearance group, the Appearance
Agent will include a <joined-dialog> or <replaced-dialog> element in
the NOTIFY containing the dialog information from the Replaces or
Joined header field.
The Appearance Agent MUST be able to communicate with the forking
proxy to learn about incoming calls and also to pass the appearance
number to the proxy or ensure the Alert-Info header field is included
in the INVITE with the appropriate appearance number.
Note that UAs need to be able to handle incoming INVITEs without
an appearance number assigned. This could be caused by a failure
of the Appearance Agent or other error condition. Although the
proper rendering of the INVITE may not be possible, this is better
than ignoring or failing the INVITE.
An Appearance Agent SHOULD assign an appearance number to an outgoing
dialog if a PUBLISH has not been received selecting/seizing a
particular appearance number.
Note that if the shared appearance group has appearance-unaware
UAs making calls, the Appearance Agent will still allocate
appearance numbers for INVITEs sent by those UAs.
An Appearance Agent receiving a PUBLISH with an appearance number
checks to make sure the publication is valid. An appearance number
can be assigned to only one dialog unless there is a <joined-dialog>
<span class="grey">Johnston, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
or <replaced-dialog> element indicating that the dialog will be/has
been replaced or joined. A 400 (Bad Request) response is returned if
the chosen appearance number is invalid, and an immediate NOTIFY
SHOULD be sent to the UA containing full dialog event state.
An Appearance Agent receiving a PUBLISH without an appearance number
but with the 'shared' Event header field parameter present interprets
this as a request by the UA to not assign an appearance number. If
the Appearance Agent policy does not allow this, a 400 (Bad Request)
response is returned. If policy does allow this, a 200 (OK) response
is returned and no appearance number is allocated. An Appearance
Agent does not have to share this dialog information (i.e., send a
NOTIFY) with other UAs in the group as the information will not be
rendered by the other UAs.
The Appearance Agent allocates an appearance number to a dialog from
the time the appearance is requested via a PUBLISH or from the
receipt of an INVITE to the time when the last dialog associated with
the appearance is terminated, including all dialogs that are joined
or replaced. During the early dialog state, the Appearance Agent
controls the rate of dialog state publication using the Expires
header field in 200 (OK) responses to PUBLISH requests. An interval
of 3 minutes is RECOMMENDED. After the dialog associated with the
publication has been confirmed, the expiration of the publication
state has no effect on the appearance allocation. If the publication
contains no dialog state information, the Appearance Agent MUST
reserve the appearance number for the UA but cannot assign the
appearance to any particular dialog of the UA. When the publication
state is updated with any dialog information, the appearance number
can then be assigned to the particular dialog. A UA that has been
allocated an appearance number using a PUBLISH MAY free up the
appearance number by removing the event state with a PUBLISH as
described in [<a href="./rfc3903" title=""Session Initiation Protocol (SIP) Extension for Event State Publication"">RFC3903</a>].
If an INVITE is sent by a member of the group to the shared AOR
(i.e., they call their own AOR), the Appearance Agent MUST assign two
appearance numbers. The first appearance number will be the one
selected or assigned to the outgoing INVITE. The second appearance
number will be another one assigned by the Appearance Agent for the
INVITE as it is forked back to the members of the group.
The is to preserve a common behavior in legacy systems.
If an INVITE is sent by a member of the group using the shared AOR or
sent to the shared AOR and no appearance number is available, the
proxy MAY reject the INVITE with a 403 (Forbidden) response code.
<span class="grey">Johnston, et al. Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Appearance numbers are only used for dialogs in which one or more UAs
associated with the group AOR are participants. If an incoming
INVITE to the group AOR is forwarded to another AOR, the appearance
number is immediately freed up and can be assigned to another dialog.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. XML Schema Definition</span>
The 'appearance', 'joined-dialog', 'replaced-dialog', and 'exclusive'
elements are defined within a new XML namespace URI. This namespace
is "urn:ietf:params:xml:ns:sa-dialog-info". The schema for these
elements is:
<span class="grey">Johnston, et al. Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema
targetNamespace="urn:ietf:params:xml:ns:sa-dialog-info"
xmlns="urn:ietf:params:xml:ns:sa-dialog-info"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<xs:element name="joined-dialog" minOccurs="0"
maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="call-id" type="xs:string"
use="mandatory"/>
<xs:attribute name="local-tag" type="xs:string"
use="mandatory"/>
<xs:attribute name="remote-tag" type="xs:string"
use="mandatory"/>
</xs:complexType>
</xs:element>
<xs:element name="replaced-dialog" minOccurs="0"
maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="call-id" type="xs:string"
use="mandatory"/>
<xs:attribute name="local-tag" type="xs:string"
use="mandatory"/>
<xs:attribute name="remote-tag" type="xs:string"
use="mandatory"/>
</xs:complexType>
</xs:element>
<xs:element name="appearance" minOccurs="0" maxOccurs="1">
<xs:simpleType type="xs:integer">
</xs:simpleType>
</xs:element>
<xs:element name="exclusive" minOccurs="0" maxOccurs="1">
<xs:simpleType type="xs:boolean">
</xs:simpleType>
</xs:element>
</xs:schema>
<span class="grey">Johnston, et al. Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Alert-Info Appearance Parameter Definition</span>
This specification extends [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] to add an 'appearance' parameter
to the Alert-Info header field and also to allow proxies to modify or
delete the Alert-Info header field.
The changes to the ABNF [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>] in <a href="./rfc3261">RFC 3261</a> are:
alert-param = LAQUOT absoluteURI RAQUOT *( SEMI
(generic-param / appearance-param) )
appearance-param = "appearance" EQUAL 1*DIGIT
A proxy inserting an 'appearance' Alert-Info parameter follows normal
Alert-Info policies. To indicate the appearance number for this
dialog, the proxy adds the Alert-Info header field with the
'appearance' parameter to the INVITE. If an Alert-Info is already
present, the proxy adds the 'appearance' parameter to the Alert-Info
header field. If an appearance number parameter is already present
(associated with another AOR or by mistake), the value is rewritten
adding the new appearance number. There MUST NOT be more than one
appearance parameter in an Alert-Info header field.
If no special ringtone is desired, a normal ringtone SHOULD be
indicated using the urn:alert:service:normal in the Alert-Info, as
per [<a href="./rfc7462" title=""URNs for the Alert-Info Header Field of the Session Initiation Protocol (SIP)"">RFC7462</a>]. The appearance number present in an Alert-Info header
field SHOULD be rendered by the UA to the user, following the
guidelines in <a href="#section-5.3">Section 5.3</a>. If the INVITE is forwarded to another
AOR, the appearance parameter in the Alert-Info SHOULD be removed
before forwarding outside the group.
The determination as to what value to use in the appearance parameter
can be done at the proxy that forks the incoming request to all the
registered UAs.
There is a variety of ways the proxy can determine what value it
should use to populate this parameter. For example, the proxy
could fetch this information by initiating a SUBSCRIBE request
with Expires: 0 to the Appearance Agent for the AOR to fetch the
list of lines that are in use. Alternatively, it could act like a
UA that is a part of the shared appearance group and SUBSCRIBE to
the State-Agent like any other UA. This would ensure that the
active dialog information is available without having to poll on a
need basis. It could keep track of the list of active calls for
the appearance AOR based on how many unique INVITE requests it has
forked to or received from the appearance AOR. Another approach
would be for the Proxy to first send the incoming INVITE to the
Appearance Agent, which would redirect to the shared appearance
<span class="grey">Johnston, et al. Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
group URI and escape the proper Alert-Info header field for the
Proxy to recurse and distribute to the other UAs in the group.
The Appearance Agent needs to know about all incoming requests to
the AOR in order to seize the appearance number. One way in which
this could be done is for the Appearance Agent to register against
the AOR with a higher q value. This will result in the INVITE
being sent to the Appearance Agent first, then being offered to
the UAs in the group.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. User Interface Considerations</span>
The appearance number allocated to a call is an important concept
that enables calls to be handled by multiple devices with
heterogeneous user interfaces in a manner that still allows users to
see a consistent model. Careful treatment of the appearance number
is essential to meet the expectations of the users. Also, rendering
the correct call/appearance state to users is also important.
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Appearance Number Rendering</span>
Since different UAs have different user interface capabilities, it is
usual to find that some UAs have restrictions that others do not.
Perfect interoperability across all UAs is clearly not possible, but
by careful design, interoperability up to the limits of each UA can
be achieved.
The following guidelines suggest how the appearance number should be
handled in three typical user interface implementations.
<span class="h4"><a class="selflink" id="section-8.1.1" href="#section-8.1.1">8.1.1</a>. Single Appearance UAs</span>
These devices are constrained by only having the capability of
displaying status indications for a single appearance. The UA SHOULD
still send messages annotated with appearance number "1". Any call
indications for appearances other than for number "1" SHOULD be
rejected with a 480 (Temporarily Unavailable) or 486 (Busy Here)
response. Note that this means that a single appearance UA cannot
answer its own call to the shared AOR, since this call would use a
second appearance number.
<span class="h4"><a class="selflink" id="section-8.1.2" href="#section-8.1.2">8.1.2</a>. Dual Appearance UAs</span>
These devices are essentially single appearance phones that implement
call waiting. They have a very simple user interface that allows
them to switch between two appearances (toggle or flash hook) and
perhaps audible tones to indicate the status of the other appearance.
Only appearance numbers "1" and "2" will be used by these UAs.
<span class="grey">Johnston, et al. Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h4"><a class="selflink" id="section-8.1.3" href="#section-8.1.3">8.1.3</a>. Shared Appearance UAs with Fixed Appearance Number</span>
This UA is the typical 'business-class' hard-phone. A number of
appearances are typically configured statically and labeled on
buttons, and calls may be managed using these configured appearances.
Any calls outside this range should be rejected, and not mapped to a
free button. Users of these devices often seize specific appearance
numbers for outgoing calls, and the UA will need to seize the
appearance number and wait for confirmation from the Appearance Agent
before proceeding with calls.
<span class="h4"><a class="selflink" id="section-8.1.4" href="#section-8.1.4">8.1.4</a>. Shared Appearance UAs with Variable Appearance Numbers</span>
This UA is typically a soft-phone or graphically rich user interface
hard-phone. In these cases, even the idea of an appearance index may
seem unnecessary. However, for these phones to be able to interwork
successfully with other phone types, it is important that they still
use the appearance index to govern the order of appearance of calls
in progress. No specific guidance on presentation is given except
that the order should be consistent. These devices can typically
make calls without waiting for confirmation from the Appearance Agent
on the appearance number.
<span class="h4"><a class="selflink" id="section-8.1.5" href="#section-8.1.5">8.1.5</a>. Example User Interface Issues</span>
The problems faced by each style of user interface are readily seen
in this example:
1. A call arrives at the shared appearance group and is assigned an
appearance number of "1". All UAs should be able to render to
the user the arrival of this call.
2. Another call arrives at the shared appearance group and is
assigned an appearance number of "2". The single appearance UA
should not present this call to the user. Other UAs should have
no problems presenting this call distinctly from the first call.
3. The first call clears, releasing appearance number "1". The
single appearance UA should now be indicating no calls since it
is unable to manage calls other than on the first appearance.
Both shared appearance UAs should clearly show that appearance
number "1" is now free, but that there is still a call on
appearance number "2".
4. A third call arrives and is assigned the appearance number of
"1". All UAs should be able to render the arrival of this new
call to the user. Multiple appearance UAs should continue to
indicate the presence of the second call, and they should also
<span class="grey">Johnston, et al. Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
ensure that the presentation order is related to the appearance
number and not the order of call arrival.
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Call State Rendering</span>
UAs that implement the shared appearances feature typically have a
user interface that provides the state of other appearances in the
group. As dialog state NOTIFYs from the Appearance Agent are
processed, this information can be rendered. Even the simplest user
interface typically has three states: idle, active, and hold. The
idle state, usually indicated by lamp off, is indicated for an
appearance when the appearance number is not associated with any
dialogs, as reported by the Appearance Agent. The active state,
usually indicated by a lamp on, means that an appearance number is
associated with at least one dialog, as reported by the Appearance
Agent. The hold state, often indicated by a blinking lamp, means the
call state from the perspective of the UA in the shared appearance
group is hold. This can be determined by the presence of the
"+sip.rendering=no" feature tag [<a href="./rfc3840" title=""Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)"">RFC3840</a>] with the local target URI.
Note that the hold state of the remote target URI is not relevant to
this display. For joined dialogs, the state is rendered as hold only
if all local target URIs are indicated with the "+sip.rendering=no"
feature tag.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Interoperability with Non-shared Appearance UAs</span>
It is desirable to allow a basic UA that does not directly support
shared appearance to be part of a shared appearance group. To
support this, the Proxy must collaborate with the Appearance Agent.
This is not required in the basic shared appearance architecture;
consequently, shared appearance interoperability with non-shared
appearance UAs will not be available in all shared appearance
deployments.
First, a UA that does not support dialog events or the shared
appearances feature will be discussed. Then, a UA that does support
dialog events but not the shared appearances feature will be
discussed.
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Appearance Assignment</span>
A UA that has no knowledge of appearances will only have appearance
numbers for outgoing calls if assigned by the Appearance Agent. If
the non-shared appearance UA does not support Join or Replaces, all
dialogs SHOULD be marked "exclusive" to indicate that these options
are not available. Marking these dialogs "exclusive" provides a
better user experience and avoids extra SIP messaging failures.
<span class="grey">Johnston, et al. Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Appearance Release</span>
In all cases, the Appearance Agent must be aware of the dialog
lifetime to release appearances back into the group.
It is also desirable that any dialog state changes (such as hold,
etc.) be made available to other UAs in the group through the Dialog
Event Package. If the Appearance Agent includes a proxy that Record-
Routes for dialogs from the non-shared-appearance-aware UA, the
Appearance Agent will know about the state of dialogs including hold,
etc. This information could be determined from inspection of non-
end-to-end-encrypted INVITE and re-INVITE messages and added to the
dialog information conveyed to other UAs.
<span class="h3"><a class="selflink" id="section-9.3" href="#section-9.3">9.3</a>. UAs Supporting Dialog Events but Not Shared Appearance</span>
Interoperability with UAs that support dialog events but not the
shared appearances feature is more straightforward. As before, all
appearance number assignments must be done by the Appearance Agent.
The Appearance Agent SHOULD still include appearance information in
NOTIFYs -- this UA will simply ignore this extra information. This
type of UA will also ignore appearance number limitations and may
attempt to join or replace dialogs marked exclusive. As a result,
the Proxy or UAs need to reject such requests or the dialogs will be
joined or taken.
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Provisioning Considerations</span>
UAs can automatically discover if this feature is active for an AOR
by looking for the 'shared' Event header field parameter in a
response to a dialog package SUBSCRIBE to the AOR, so no provisioning
for this is needed.
The registrar will need to be provisioned to accept either first or
third party registrations for the shared AOR. First party
registration means the To and From URIs in the REGISTER request are
the shared AOR URI. Third-party registration means the To URI is the
shared AOR URI and the From URI is a different AOR, perhaps that of
the individual user. Either the credentials of the shared AOR or the
user MUST be accepted by the registrar and the Appearance Agent,
depending on the authorization policy in place for the domain.
If the Appearance Agent needs to subscribe to the dialog state of the
UAs, then the Appearance Agent and the UAs need to be provisioned
with credentials so the UAs can authenticate the Appearance Agent.
In some cases, UAs in the shared appearance group might have a UI
limitation on the number of appearances that can be rendered.
<span class="grey">Johnston, et al. Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Typically, this will be hard-phones with buttons/lamps instead of
more flexible UIs. In this case, it can be useful for the Appearance
Agent to know this maximum number. This can allow the Appearance
Agent to apply policy when this limit is reached, e.g., deny a call.
However, this mechanism does not provide any way to discover this by
protocol means.
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Example Message Flows</span>
The next section shows call flow and message examples. The flows and
descriptions are non-normative. Note that, in these examples, all
INVITEs sent by a UA in the group will be From the shared AOR
(sip:HelpDesk@example.com in this case), and all INVITES sent to the
group will have a Request-URI of the shared AOR. Any other requests
would not apply to this feature and would be handled using normal SIP
mechanisms.
Note that the first 12 examples assume the Appearance Agent is aware
of dialog state events. The example in <a href="#section-11.13">Section 11.13</a> shows the case
where this is not the case, and, as a result, the Appearance Agent
initiates a subscription to users of the shared AOR. Any of the
other call flow examples could have shown this mode of operation as
it is equally valid.
<span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.1</a>. Registration and Subscription</span>
Bob and Alice are in a shared appearance group identified by the
shared appearance AOR sip:HelpDesk@example.com. Bob REGISTERs using
contact sip:bob@ua2.example.com. Alice REGISTERs with contact
sip:alice@ua1.example.com.
UAs for Alice and Bob subscribe to the dialog package for the
appearance AOR and publish dialog state to the Appearance Agent.
Message exchanges between the Registrar, Appearance Agent, Alice, and
Bob are shown below. The call flow examples below do not show the
authentication of subscriptions, publications, and notifications. It
should be noted that for security purposes, all publications and
subscriptions must be authorized before they are accepted.
Also note that registrations and subscriptions must all be refreshed
by Alice at intervals determined by the expiration intervals returned
by the Registrar or Appearance Agent.
Registrar Appearance Agent Alice Bob
| | | |
| | | |
|<--------------------------- REGISTER F1<| |
| | | |
<span class="grey">Johnston, et al. Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
|>F2 200 OK ----------------------------->| |
| | | |
| |<----- SUBSCRIBE F3<| |
| | | |
| |>F4 200 OK -------->| |
| | | |
| |>F5 NOTIFY -------->| |
| | | |
| |<-------- 200 OK F6<| |
| | | |
|<-------------------------------------------- REGISTER F7<|
| | | |
|>F8 200 OK ---------------------------------------------->|
| | | |
| |<---------------------- SUBSCRIBE F9<|
| | | |
| |>F10 200 OK ------------------------>|
| | | |
| |>F11 NOTIFY ------------------------>|
| | | |
| |<------------------------ 200 OK F12<|
| | | |
Figure 1. Registration and Subscription Example
F1-F2: Alice registers AOR with
contact: <sip:alice@ua1.example.com>
F1 Alice ----> Registrar
REGISTER sip:registrar.example.com SIP/2.0
Via: SIP/2.0/UDP ua1.example.com;branch=z9hG4bK527b54da8ACC7B09
From: <sip:alice@example.com>;tag=CDF9A668-909E2BDD
To: <sip:HelpDesk@example.com>
CSeq: 2 REGISTER
Call-ID: d3281184-518783de-cc23d6bb
Contact: <sip:alice@ua1.example.com>
Max-Forwards: 70
Expires: 3600
Content-Length: 0
F2 Registrar ----> Alice
SIP/2.0 200 OK
Via: SIP/2.0/UDP ua1.example.com;branch=z9hG4bK527b54da8ACC7B09
CSeq: 2 REGISTER
Call-ID: d3281184-518783de-cc23d6bb
<span class="grey">Johnston, et al. Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
From: <sip:alice@example.com>;tag=CDF9A668-909E2BDD
To: <sip:HelpDesk@example.com>;tag=1664573879820199
Contact: <sip:alice@ua1.example.com>;expires=3600
Content-Length: 0
F3 to F6: Alice also subscribes to the events associated with the
Appearance AOR. Appearance Agent notifies Alice of the status.
F3 Alice ----> Appearance Agent
SUBSCRIBE sip:HelpDesk@example.com SIP/2.0
Via: SIP/2.0/UDP ua1.example.com;branch=z9hG4bKf10fac97E7A76D6A
From: <sip:alice@example.com>;tag=925A3CAD-CEBB276E
To: <sip:HelpDesk@example.com>
CSeq: 91 SUBSCRIBE
Call-ID: ef4704d9-bb68aa0b-474c9d94
Contact: <sip:alice@ua1.example.com>
Event: dialog;shared
Accept: application/dialog-info+xml
Max-Forwards: 70
Expires: 3700
Content-Length: 0
F4 Appearance Agent ----> Alice
SIP/2.0 200 OK
Via: SIP/2.0/UDP ua1.example.com;branch=z9hG4bKf10fac97E7A76D6A
CSeq: 91 SUBSCRIBE
Call-ID: ef4704d9-bb68aa0b-474c9d94
From: <sip:alice@example.com>;tag=925A3CAD-CEBB276E
To: <sip:HelpDesk@example.com>;tag=1636248422222257
Allow-Events: dialog
Expires: 3700
Contact: <sip:appearanceagent.example.com>
Content-Length: 0
F5 Appearance Agent ----> Alice
NOTIFY sip:alice@ua1.example.com SIP/2.0
From: <sip:HelpDesk@example.com>;tag=1636248422222257
To: <sip:alice@example.com>;tag=925A3CAD-CEBB276E
Call-ID: ef4704d9-bb68aa0b-474c9d94
CSeq: 232 NOTIFY
Via: SIP/2.0/UDP appearanceagent.example.com;branch=z9hG4bK1846
Max-Forwards: 70
<span class="grey">Johnston, et al. Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Content-Type: application/dialog-info+xml
Event: dialog;shared
Subscription-State: active;expires=3000
Contact: <sip:appearanceagent.example.com>
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
version="40"
state="full"
entity="sip:HelpDesk@example.com">
</dialog-info>
F6 Alice ----> Appearance Agent
SIP/2.0 200 OK
Via: SIP/2.0/UDP appearanceagent.example.com;branch=z9hG4bK1846
From: <sip:HelpDesk@example.com>;tag=1636248422222257
To: <sip:alice@example.com>;tag=925A3CAD-CEBB276E
CSeq: 232 NOTIFY
Call-ID: ef4704d9-bb68aa0b-474c9d94
Contact: <sip:alice@ua1.example.com>
Content-Length: 0
F7 Bob ----> Registrar
REGISTER sip:registrar.example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4b53b54d87B
From: <sip:bob@example.com>;tag=34831131
To: <sip:HelpDesk@example.com>
CSeq: 72 REGISTER
Call-ID: 139490230230249348
Contact: <sip:bob@ua2.example.com>
Max-Forwards: 70
Expires: 3600
Content-Length: 0
F8 Registrar ----> Bob
SIP/2.0 200 OK
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4b53b54d87B
From: <sip:bob@example.com>;tag=34831131
To: <sip:HelpDesk@example.com>;tag=fkwlwqi1
CSeq: 72 REGISTER
Call-ID: 139490230230249348
<span class="grey">Johnston, et al. Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Contact: <sip:alice@ua1.example.com>;expires=3200
Contact: <sip:bob@ua2.example.com>;expires=3600
Content-Length: 0
<span class="h3"><a class="selflink" id="section-11.2" href="#section-11.2">11.2</a>. Appearance Selection for Incoming Call</span>
In the call flow below, Bob and Alice are in a shared appearance
group. Carol places a call to the shared appearance group AOR. The
Appearance Agent sends NOTIFYs to Alice and Bob telling them what
appearance the call is using. Both Alice and Bob's devices are
alerted of the incoming call. Bob answers the call.
Note that it is possible that both Alice and Bob answer the call and
send 200 (OK) responses to Carol. It is up to Carol to resolve this
situation. Typically, Carol will send ACKs to both 200 OKs but send
a BYE to terminate one of the dialogs. As a result, either Alice or
Bob will receive the BYE and publish that their dialog is over.
However, if Carol answers both Alice and Bob and keeps both dialogs
active, then the Appearance Agent will need to resolve the situation
by moving either Alice or Bob's dialog to a different appearance.
All NOTIFY messages in the call flow below carry dialog events and
only dialog states are mentioned for simplicity. For brevity, the
details of some messages are not shown below. Note that the order of
F2 - F5 and F7 - F8 could be reversed.
Forking Appearance
Carol Proxy Agent Alice Bob
| | | | |
|>F1 INVITE >| | | |
| |< - - - - - >| | |
| | |>F2 NOTIFY ----------->|
| | | | |
| | |<F3 200 OK -----------<|
| | | | |
| | |>F4 NOTIFY ->| |
| | | | |
| | |<-200 OK F5-<| |
|<- 100 F6 -<| | | |
| |>F7 INVITE (appearance=1) ---------->|
| | | | |
| |>F8 INVITE (appearance=1) >| |
| | | | |
| |<-------------------- Ringing 180 F9<|
|< 180 F10 -<| | | |
<span class="grey">Johnston, et al. Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| |<--------- 180 Ringing F11<| |
|< 180 F12 -<| | | |
| | | | |
| |<------------------------ 200 OK F13<|
|< 200 F14 -<| | | |
| | | | |
| |>F15 CANCEL -------------->| |
| | | | |
| |<-------------- 200 OK F16<| |
| | | | |
| |<Request Cancelled 487 F17<| |
| | | | |
| |>F18 ACK ----------------->| |
|>F19 ACK -->| | | |
| |>F20 ACK --------------------------->|
| | | | |
|<=============Both way RTP established===========>|
| | | | |
| |< - - - - - >| | |
| | | | |
| | |>F21 NOTIFY >| |
| | | | |
| | |<- 200 F22 -<| |
| | | | |
| | |>F23 NOTIFY ---------->|
| | | | |
| | |<F24 200 OK ----------<|
| | | |
Figure 2. Appearance Selection for Incoming Call Example
F4 Appearance Agent ----> Alice
NOTIFY sip:alice@ua1.example.com SIP/2.0
From: <sip:HelpDesk@example.com>;tag=151702541050937
To: <sip:alice@example.com>;tag=18433323-C3D237CE
Call-ID: 1e361d2f-a9f51109-bafe31d4
CSeq: 12 NOTIFY
Via: SIP/2.0/UDP appearanceagent.example.com;branch=z9hG4bK1403
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Event: dialog;shared
Subscription-State: active;expires=2800
Contact: <sip:appearanceagent.example.com>
Content-Length: ...
<?xml version="1.0"?>
<span class="grey">Johnston, et al. Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="13"
state="partial"
entity="sip:HelpDesk@example.com">
<dialog id="2a7294823093f5274e3fd2ec54a2d76c"
call-id="14-1541707345"
remote-tag="44BAD75D-E3128D42"
direction="recipient">
<sa:appearance>1</sa:appearance>
<state>trying</state>
<remote>
<identity>sip:carol@ua.example.com</identity>
</remote>
</dialog>
</dialog-info>
F7 Proxy ----> Bob
INVITE sip:bob@ua2.example.com SIP/2.0
Via: SIP/2.0/UDP ua3.example.com;branch=z9hG4bK4324ea
Via: SIP/2.0/UDP proxy.example.com;branch=z9hG4bK38432ji
From: <sip:carol@example.com>;tag=44BAD75D-E3128D42
To: <sip:HelpDesk@example.com>
CSeq: 106 INVITE
Call-ID: 14-1541707345
Contact: <sip:carol@ua3.example.com>
Max-Forwards: 69
Alert-Info: <urn:alert:service:normal>;appearance=1
Content-Type: application/sdp
Content-Length: ...
v=0
o=- 1102980499 1102980499 IN IP4 ua3.example.com
s=
c=IN IP4 ua3.example.com
t=0 0
m=audio 2238 RTP/AVP 0 8 101
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:101 telephone-event/8000
F21 Appearance Agent ----> Alice
NOTIFY sip:alice@ua1.example.com SIP/2.0
From: <sip:HelpDesk@example.com>;tag=151702541050937
<span class="grey">Johnston, et al. Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
To: <sip:alice@example.com>;tag=18433323-C3D237CE
Call-ID: 1e361d2f-a9f51109-bafe31d4
CSeq: 13 NOTIFY
Via: SIP/2.0/UDP appearanceagent.example.com;branch=z9hG4bK4164F03j
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Event: dialog;shared
Subscription-State: active;expires=2500
Contact: <sip:appearanceagent.example.com>
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="17"
state="partial"
entity="sip:HelpDesk@example.com">
<dialog id="2a7294823093f5274e3fd2ec54a2d76c"
call-id="14-1541707345"
remote-tag="44BAD75D-E3128D42"
local-tag="7349dsfjkFD03s"
direction="recipient">
<sa:appearance>1</sa:appearance>
<state>confirmed</state>
<local>
<target>sip:bob@ua2.example.com</target>
</local>
<remote>
<identity>sip:carol@ua.example.com</identity>
</remote>
</dialog>
</dialog-info>
<span class="h3"><a class="selflink" id="section-11.3" href="#section-11.3">11.3</a>. Outgoing Call without Appearance Seizure</span>
In this scenario, Bob's UA places a call without first selecting/
seizing an appearance number. After Bob sends the INVITE, the
appearance assigns an appearance number for it and notifies both
Alice and Bob.
Carol Proxy Alice Appearance Agent Bob
| | | | |
| | | | |
| |<------------------------------------- INVITE F1<|
| | | | |
| |>F2 100 Trying --------------------------------->|
<span class="grey">Johnston, et al. Standards Track [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
|<-- INVITE F3<| | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<-- NOTIFY F4<| |
| | | | |
| | |>F5 200 OK -->| |
| | | |------- NOTIFY F6>|
| | | | |
| | | |<F7 200 OK ------<|
|>F8 180 ---->| | | |
| |>F9 180 Ringing -------------------------------->|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F10<| |
| | | | |
| | |>F11 200 OK ->| |
| | | |------ NOTIFY F12>|
| | | | |
| | | |<F13 200 OK -----<|
|>F14 200 OK ->| | | |
| |>F15 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F16<|
|<---- ACK F17<| | | |
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F18<| |
| | | | |
| | |>F19 200 OK ->| |
| | | |------ NOTIFY F20>|
| | | | |
| | | |<F21 200 OK -----<|
| | | | |
Figure 3. Outgoing Call without Appearance Seizure Example
F1 Bob ----> Proxy
INVITE sip:carol@example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bK98c87c52123A08BF
From: <sip:HelpDesk@example.com>;tag=15A3DE7C-9283203B
To: <sip:carol@example.com>
CSeq: 1 INVITE
<span class="grey">Johnston, et al. Standards Track [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Call-ID: f3b3cbd0-a2c5775e-5df9f8d5
Contact: <sip:bob@ua2.example.com>
Max-Forwards: 70
Content-Type: application/sdp
Content-Length: 223
v=0
o=- 1102980499 1102980499 IN IP4 ua2.example.com
s=IP SIP UA
c=IN IP4 ua2.example.com
t=0 0
a=sendrecv
m=audio 2236 RTP/AVP 0 8 101
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:101 telephone-event/8000
F4 Appearance Agent ----> Alice
NOTIFY sip:alice@ua1.example.com SIP/2.0
Via: SIP/2.0/UDP appearanceagent.example.com;branch=z9hG4bK81d84f62
From: <sip:HelpDesk@example.com>;tag=1636248422222257
To: <sip:alice@example.com>;tag=925A3CAD-CEBB276E
Call-ID: ef4704d9-bb68aa0b-474c9d94
CSeq: 233 NOTIFY
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Event: dialog;shared
Subscription-State: active;expires=2200
Contact: <sip:appearanceagent.example.com>
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="27"
state="partial"
entity="sip:HelpDesk@example.com">
<dialog id="fa02538339df3ce597f9e3e3699e28fc"
call-id="f3b3cbd0-a2c5775e-5df9f8d5"
local-tag="15A3DE7C-9283203B" direction="initiator">
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<state>trying</state>
<local>
<target uri="sip:bob@ua2.example.com">
</target>
<span class="grey">Johnston, et al. Standards Track [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
</local>
</dialog>
</dialog-info>
F6 Appearance Agent ----> Bob
NOTIFY sip:bob@ua1.example.com SIP/2.0
From: <sip:HelpDesk@example.com>;tag=497585728578386
To: <sip:bob@example.com>;tag=633618CF-B9C2EDA4
Call-ID: a7d559db-d6d7dcad-311c9e3a
CSeq: 7 NOTIFY
Via: SIP/2.0/UDP appearanceagent.example.com
;branch=z9hG4bK1711759878512309
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Event: dialog;shared
Subscription-State: active;expires=2000
Contact: <sip:appearanceagent.example.com>
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="78"
state="partial"
entity="sip:HelpDesk@example.com">
<dialog id="02538339hfgdf3ce597f9e3egkl3699e28fc"
call-id="f3b3cbd0-a2c5775e-5df9f8d5"
local-tag="15A3DE7C-9283203B" direction="initiator">
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<state>trying</state>
<local>
<target uri="sip:bob@ua2.example.com">
</target>
</local>
</dialog>
</dialog-info>
<span class="h3"><a class="selflink" id="section-11.4" href="#section-11.4">11.4</a>. Outgoing Call with Appearance Seizure</span>
In this scenario, Bob's UA sends out a dialog event PUBLISH with
state (trying) selecting/seizing an appearance number before sending
the INVITE. After receiving the 200 (OK) from the Appearance Agent
confirming the appearance number, Bob's UA sends the INVITE to Carol
and establishes a session. For brevity, details of some of the
messages are not included in the message flows. Bob's UA puts as
<span class="grey">Johnston, et al. Standards Track [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
much of the dialog information from F7 as can be determined in
advance. In this case, the minimum of the Contact URI is included,
which allows the Appearance Agent to correlate the INVITE with the
PUBLISH.
Carol Proxy Alice Appearance Agent Bob
| | | | |
| | | |<----- PUBLISH F1<|
| | | | |
| | | |>F2 200 OK ------>|
| | | | |
| | |<-- NOTIFY F3<| |
| | | | |
| | |>F4 200 OK -->| |
| | | |------- NOTIFY F5>|
| | | | |
| | | |<F6 200 OK ------<|
| | | | |
| |<------------------------------------- INVITE F7<|
| | | | |
| |>F8 100 Trying --------------------------------->|
|<-- INVITE F9<| | | |
| | | |<---- PUBLISH F10<|
| | | | |
| | | |>F11 200 OK ----->|
| | | | |
|>F12 180 --->| | | |
| |>F13 180 Ringing ------------------------------->|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F14<| |
| | | | |
| | |>F15 200 OK ->| |
| | | |------ NOTIFY F16>|
| | | | |
| | | |<F17 200 OK -----<|
|>F18 200 OK ->| | | |
| |>F19 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F20<|
|<---- ACK F21<| | | |
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F22<| |
<span class="grey">Johnston, et al. Standards Track [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | | | |
| | |>F23 200 OK ->| |
| | | |------ NOTIFY F24>|
| | | | |
| | | |<F25 200 OK -----<|
| | | | |
Figure 4. Outgoing Call with Appearance Seizure Example
F1 to F4: Bob uses the shared appearance of the Help Desk on his UA
to place an outgoing call (e.g., he goes off-hook). Before sending
the outgoing INVITE request, Bob publishes to the Appearance Agent
reserving appearance number 1. The Appearance Agent notifies Alice
(and all other UAs, including Bob) of the event by sending NOTIFYs.
F1 Bob ----> Appearance Agent
PUBLISH sip:HelpDesk@example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bK61314d6446383E79
From: <sip:bob@example.com>;tag=44150CC6-A7B7919D
To: <sip:HelpDesk@example.com>
CSeq: 7 PUBLISH
Call-ID: 44fwF144-F12893K38424
Contact: <sip:bob@ua2.example.com>
Event: dialog;shared
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="6"
state="full"
entity="sip:HelpDesk@example.com">
<dialog id="id3d4f9c83" direction="initiator">
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<state>trying</state>
<local>
<target uri="sip:bob@ua2.example.com">
</target>
</local>
</dialog>
</dialog-info>
<span class="grey">Johnston, et al. Standards Track [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
F2 Appearance Agent ----> Bob
SIP/2.0 200 OK
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bK61314d6446383E79
From: <sip:bob@example.com>;tag=44150CC6-A7B7919D
To: <sip:HelpDesk@example.com>
CSeq: 7 PUBLISH
Call-ID: 44fwF144-F12893K38424
Contact: <sip:bob@ua2.example.com>
Event: dialog;shared
SIP-Etag: 482943245
Allow-Events: dialog
Expires: 60
Content-Length: 0
F7 Bob ---> Proxy
INVITE sip:carol@example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bK342122
Max-Forwards: 70
From: <sip:HelpDesk@example.com>;tag=15A3DE7C-9283203B
To: <sip:carol@example.com>
Call-ID: f3b3cbd0-a2c5775e-5df9f8d5
CSeq: 31 INVITE
Contact: <sip:bob@ua2.example.com>
Content-Type: application/sdp
Content-Length: ...
(SDP Not Shown)
F10 Bob ----> Appearance Agent
PUBLISH sip:HelpDesk@example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bK6d644638E7
From: <sip:bob@example.com>;tag=0CCf6-A7FdsB79D
To: <sip:HelpDesk@example.com>
CSeq: 437 PUBLISH
Call-ID: fwF14d4-F1FFF2F2893K38424
Contact: <sip:bob@ua2.example.com>
Event: dialog;shared
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
<span class="grey">Johnston, et al. Standards Track [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="6"
state="full"
entity="sip:HelpDesk@example.com">
<dialog id="id3d4f9c83"
call-id="f3b3cbd0-a2c5775e-5df9f8d5"
local-tag="15A3DE7C-9283203B"
direction="initiator">
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<state>trying</state>
<local>
<target uri="sip:bob@ua2.example.com">
</target>
</local>
<remote>
<identity uri="sip:carol@example.com">
</identity>
</remote>
</dialog>
</dialog-info>
<span class="h3"><a class="selflink" id="section-11.5" href="#section-11.5">11.5</a>. Outgoing Call without Using an Appearance Number</span>
In this scenario, Bob's UA sends out a dialog event PUBLISH with
state (trying) indicating that he does not want to utilize an
appearance number for this dialog. The PUBLISH does not have an
appearance element but does have the 'shared' Event header field
parameter. As a result, the Appearance Agent knows the UA does not
wish to use an appearance number for this call. If the Appearance
Agent does not wish to allow this, it would reject the PUBLISH with a
400 (Bad Request) response and the UA would know to re-PUBLISH
selecting/seizing an appearance number.
Carol Proxy Alice Appearance Agent Bob
| | | | |
| | | |<----- PUBLISH F1<|
| | | | |
| | | |>F2 200 OK ------>|
| | | | |
| | |<-- NOTIFY F3<| |
| | | | |
| | |>F4 200 OK -->| |
| | | |------- NOTIFY F5>|
| | | | |
| | | |<F6 200 OK ------<|
| | | | |
| |<------------------------------------- INVITE F7<|
<span class="grey">Johnston, et al. Standards Track [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | | | |
| |>F8 100 Trying --------------------------------->|
|<-- INVITE F9<| | | |
| | | |<---- PUBLISH F10<|
| | | | |
| | | |>F11 200 OK ----->|
| | | | |
|>F12 180 --->| | | |
| |>F13 180 Ringing ------------------------------->|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F14<| |
| | | | |
| | |>F15 200 OK ->| |
| | | |------ NOTIFY F16>|
| | | | |
| | | |<F17 200 OK -----<|
|>F18 200 OK ->| | | |
| |>F19 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F20<|
|<---- ACK F21<| | | |
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F22<| |
| | | | |
| | |>F23 200 OK ->| |
| | | |------ NOTIFY F24>|
| | | | |
| | | |<F25 200 OK -----<|
| | | | |
Figure 5. Outgoing Call without using an Appearance Number Example
F1 Bob ----> Appearance Agent
PUBLISH sip:appearanceagent.example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bK61314d6446383E79
From: <sip:bob@example.com>;tag=4415df82k39sf
To: <sip:HelpDesk@example.com>
CSeq: 7 PUBLISH
Call-ID: 44fwF144-F12893K38424
Contact: <sip:bob@ua2.example.com>
<span class="grey">Johnston, et al. Standards Track [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Event: dialog;shared
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="6"
state="full"
entity="sip:HelpDesk@example.com">
<dialog id="id3d4f9c83" direction="initiator">
<sa:exclusive>false</sa:exclusive>
<state>trying</state>
<local>
<target uri="sip:bob@ua2.example.com">
</target>
</local>
</dialog>
</dialog-info>
Note that F7 would be the same as the previous example.
<span class="h3"><a class="selflink" id="section-11.6" href="#section-11.6">11.6</a>. Appearance Release</span>
Bob and Carol are in a dialog, created, for example as in
<a href="#section-11.3">Section 11.3</a>. Carol sends a BYE to Bob to terminate the dialog and
the Appearance Agent de-allocates the appearance number used, sending
notifications out to the UAs in the shared group.
Carol Proxy Alice Appearance Agent Bob
| | | | |
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
|>F22 BYE ---->| | | |
| |>F23 BYE --------------------------------------->|
| | | | |
| |<------------------------------------ 200 OK F24<|
|<--200 OK F25<| | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F26<| |
| | | | |
| | |>F27 200 OK ->| |
| | | |------ NOTIFY F28>|
| | | | |
| | | |<F29 200 OK -----<|
<span class="grey">Johnston, et al. Standards Track [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Figure 6. Appearance Release Example
F28 Appearance Agent ----> Bob
NOTIFY sip:bob@ua1.example.com SIP/2.0
From: <sip:HelpDesk@example.com>;tag=497585728578386
To: <sip:bob@example.com>
Call-ID: a7d559db-d6d7dcad-311c9e3a
CSeq: 7 NOTIFY
Via: SIP/2.0/UDP appearanceagent.example.com
;branch=z9hG4bK759878512309
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Event: dialog;shared
Subscription-State: active;expires=1800
Contact: <sip:appearanceagent.example.com>
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="27"
state="partial"
entity="sip:HelpDesk@example.com">
<dialog id="fa02538339df3ce597f9e3e3699e28fc"
call-id="f3b3cbd0-a2c5775e-5df9f8d5"
local-tag="15A3DE7C-9283203B"
remote-tag="65a98f7c-1dd2-11b2-88c6-b0316298f7c"
direction="initiator">
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<state>terminated</state>
<local>
<target uri="sip:bob@ua2.example.com">
</target>
</local>
</dialog>
</dialog-info>
<span class="h3"><a class="selflink" id="section-11.7" href="#section-11.7">11.7</a>. Appearance Pickup</span>
In this scenario, Bob has an established dialog with Carol created
using the call flows of Figures 1 or 2. Bob then places Carol on
hold. Alice receives a notification of this and renders this on
Alice's UI. Alice subsequently picks up the held call and has a
established session with Carol. Finally, Carol hangs up. Alice must
PUBLISH F32 to indicate that the INVITE F38 will be an attempt to
<span class="grey">Johnston, et al. Standards Track [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
pickup the dialog between Carol and Bob and, hence, may use the same
appearance number. This example also shows Secure SIP (sips) being
used.
Carol Proxy Alice Appearance Agent Bob
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
| |<------------------------------(hold) INVITE F22<|
|<- INVITE F23<| | | |
| | | | |
|>F24 200 OK ->| | | |
| |>F25 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F26<|
|<---- ACK F27<| | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F28<| |
| | | | |
| | |>F29 200 OK ->| |
| | | |>F30 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F31<|
| | | | |
| | Alice decides to pick up the call |
| | | | |
| | |>F32 PUBLISH->| |
| | | | |
| | |<- 200 OK F33<| |
| | | | |
| | |<- NOTIFY F34<| |
| | | | |
| | |>F35 200 OK ->| |
| | | |>F36 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F37<|
| |<-- INVITE F38<| | |
|<- INVITE F39<|(w/ Replaces) | | |
|( w/ Replaces)| | | |
|>F40 200 OK ->| | | |
| |>F41 200 OK -->| | |
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | | |>F42 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F43<|
<span class="grey">Johnston, et al. Standards Track [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | |<- NOTIFY F44<| |
| | | | |
| | |>F45 200 OK ->| |
| | | | |
| |<----- ACK F46<| | |
|<---- ACK F47<| | | |
| | | | |
|<= Both way RTP established =>| | |
| | | | |
|>F48 BYE ---->| | | |
| |>F49 BYE --------------------------------------->|
| | | | |
| |<------------------------------------ OK 200 F50<|
|<- 200 OK F51<| | | |
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F52<| |
| | | | |
| | |>F53 200 OK ->| |
| | | | |
| | | |>F54 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F55<|
Figure 7. Appearance Pickup Example
F28 Appearance ----> Alice
NOTIFY sips:alice@ua1.example.com SIP/2.0
From: <sips:HelpDesk@example.com>;tag=151702541050937
To: <sips:alice@example.com>;tag=18433323-C3D237CE
Call-ID: 1e361d2f-a9f51109-bafe31d4
CSeq: 12 NOTIFY
Via: SIP/2.0/TLS appearanceagent.example.com
;branch=z9hG4bK1403
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Event: dialog;shared
Subscription-State: active;expires=1800
Contact: <sips:appearanceagent.example.com>
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="10"
<span class="grey">Johnston, et al. Standards Track [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
state="partial"
entity="sips:HelpDesk@example.com">
<dialog id="id3d4f9c83"
call-id="f3b3cbd0-a2c5775e-5df9f8d5"
local-tag="15A3DE7C-9283203B"
remote-tag="65a98f7c-1dd2-11b2-88c6-b0316298f7c"
direction="initiator">
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<state>active</state>
<local>
<target uri="sips:bob@ua2.example.com">
<param pname="+sip.rendering" pval="no"/>
</target>
</local>
<remote>
<identity>sips:carol@example.com</identity>
<target uri="sips:carol@ua3.example.com" />
</remote>
</dialog>
</dialog-info>
F32 Alice ----> Appearance Agent
PUBLISH sips:HelpDesk@example.com SIP/2.0
Via: SIP/2.0/TLS ua2.example.com;branch=z9hG4bKa5d6cf61F5FBC05A
From: <sips:HelpDesk@example.com>;tag=44150CC6-A7B7919D
To: <sips:alice@example.com>;tag=428765950880801
CSeq: 11 PUBLISH
Call-ID: 87837Fkw87asfds
Contact: <sips:alice@ua2.example.com>
Event: dialog;shared
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="10"
state="full"
entity="sips:HelpDesk@example.com">
<dialog id="id3d4f9c83"
call-id="3d57cd17-47deb849-dca8b6c6"
local-tag="8C4183CB-BCEAB710" >
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<span class="grey">Johnston, et al. Standards Track [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<sa:replaced-dialog
call-id="f3b3cbd0-a2c5775e-5df9f8d5"
from-tag="15A3DE7C-9283203B"
to-tag="65a98f7c-1dd2-11b2-88c6-b03162323164+65a98f7c" />
<state>trying</state>
<local>
<target uri="sips:alice@ua1.example.com">
<param pname="+sip.rendering" pval="yes"/>
</target>
</local>
<remote>
<target uri="sips:carol@ua3.example.com" />
</remote>
</dialog>
</dialog-info>
F38 Alice ----> Proxy
INVITE sips:carol@example.com SIP/2.0
Via: SIP/2.0/TLS ua1.example.com;branch=z9hG4bK4ea695b5B376A60C
From: <sips:HelpDesk@example.com>;tag=8C4183CB-BCEAB710
To: <sips:carol@example.com:5075>
CSeq: 1 INVITE
Call-ID: 3d57cd17-47deb849-dca8b6c6
Contact: <sips:alice@ua1.example.com>
<all-one-line>
Replaces: f3b3cbd0-a2c5775e-5df9f8d5;to-tag=65a98f7c
-1dd2-11b2-88c6-b03162323164+65a98f7c;from-tag=15A3DE7C-9283203B
</all-one-line>
Max-Forwards: 70
Content-Type: application/sdp
Content-Length: 223
v=0
o=- 1102980497 1102980497 IN IP4 ua1.example.com
s=IP SIP UA
c=IN IP4 ua1.example.com
t=0 0
a=sendrecv
m=audio 2238 RTP/AVP 0 8 101
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:101 telephone-event/8000
<span class="grey">Johnston, et al. Standards Track [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h3"><a class="selflink" id="section-11.8" href="#section-11.8">11.8</a>. Call between UAs within the Group</span>
In this scenario, Bob calls Alice who is also in the shared
appearance group. Only one appearance number is used for this
dialog. This example also shows the use of the 'exclusive' tag to
indicate that other UAs in the group can not join or take this
dialog.
Carol Proxy Alice Appearance Agent Bob
| | | | |
| |<-------------------- INVITE (to Alice's UA) F1<|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | | | |
| | |<-- NOTIFY F2<| |
| | | | |
| | |>F3 200 OK -->| |
| | | |>F4 NOTIFY ------>|
| | | | |
| | | |<------ 200 OK F5<|
| |>F6 INVITE --->| | |
| | (appearance=1)| | |
| | | | |
| |<------ 180 F7<| | |
| | | | |
| |>F8 180 --------------------------------------->|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<-- NOTIFY F9<| |
| | | | |
| | |>F10 200 OK ->| |
| | | |>F11 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F12<|
| |<-- 200 OK F13<| | |
| | | | |
| |>F14 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F15<|
| | | | |
| |>F16 ACK ----->| | |
| | | | |
| | |<======= RTP established =======>|
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
<span class="grey">Johnston, et al. Standards Track [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | |<- NOTIFY F17<| |
| | | | |
| | |>F18 200 OK ->| |
| | | |>F19 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F24<|
| | | | |
Figure 8. Call between UAs within the Group Example
F19 Appearance Agent ----> Bob
NOTIFY sip:bob@ua1.example.com SIP/2.0
From: <sip:HelpDesk@example.com>;tag=497585728578386
To: <sip:bob@example.com>;tag=633618CF-B9C2EDA4
Call-ID: a7d559db-d6d7dcad-311c9e3a
CSeq: 7 NOTIFY
Via: SIP/2.0/UDP appearanceagent.example.com
;branch=z9hG4bK1711759878512309
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Event: dialog;shared
Subscription-State: active;expires=1500
Contact: <sip:appearanceagent.example.com>
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="10"
state="partial"
entity="sip:HelpDesk@example.com">
<dialog id="3xdsd4f9c83"
call-id="b3cbd0-ad2c5775e-5df9f8d5"
local-tag="34322kdfr234f"
remote-tag="3153DE7C-928203B"
direction="initiator">
<sa:exclusive>true</sa:exclusive>
<sa:appearance>1</sa:appearance>
<state>confirmed</state>
<local>
<target uri="sip:bob@ua2.example.com">
</target>
</local>
<remote>
<identity>sip:HelpDesk@example.com</identity>
<target uri="sip:alice@ua1.example.com" />
<span class="grey">Johnston, et al. Standards Track [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
</remote>
</dialog>
<dialog id="4839589"
call-id="b3cbd0-ad2c5775e-5df9f8d5"
local-tag="3153DE7C-928203B"
remote-tag="34322kdfr234f"
direction="responder">
<sa:exclusive>true</sa:exclusive>
<sa:appearance>1</sa:appearance>
<state>confirmed</state>
<local>
<target uri="sip:alice@ua1.example.com" />
</local>
<remote>
<identity>sip:HelpDesk@example.com</identity>
<target uri="sip:bob@ua2.example.com" />
</remote>
</dialog>
</dialog-info>
<span class="h3"><a class="selflink" id="section-11.9" href="#section-11.9">11.9</a>. Consultation Hold with Appearances</span>
In this scenario, Bob has a call with Carol. Bob makes a
consultation call to Alice by putting Carol on hold and calling
Alice. Bob's UA chooses not to have an appearance number for the
call to Alice since it is treating it as part of the call to Carol.
He indicates this in the PUBLISH F32, which contains the 'shared'
Event header field parameter but no <appearance> element. The
PUBLISH is sent before the INVITE to Alice to ensure no appearance
number is assigned by the Appearance Agent. Finally, Bob hangs up
with Alice and resumes the call with Carol. Dialog notifications of
the consultation call are not shown, as they are not used.
Note that if Carol hangs up while Bob is consulting with Alice, Bob
can decide if he wants to reuse the appearance number used with Carol
for the call with Alice. If not, Bob publishes the termination of
the dialog with Carol and the Appearance Agent will re-allocate the
appearance. If he wants to keep the appearance, Bob will publish the
termination of the dialog with Carol and also publish the appearance
with the dialog with Alice. This will result in Bob keeping the
appearance number until he reports the dialog with Alice terminated.
Note that the call flow would be similar if Bob called a music on
hold server instead of Alice to implement a music on hold service as
described in [<a href="./rfc7088" title=""Session Initiation Protocol Service Example -- Music on Hold"">RFC7088</a>].
<span class="grey">Johnston, et al. Standards Track [Page 52]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Carol Proxy Alice Appearance Agent Bob
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
| |<------------------------------(hold) INVITE F22<|
|<- INVITE F23<| | | |
| | | | |
|>F24 200 OK ->| | | |
| |>F25 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F26<|
|<---- ACK F27<| | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F28<| |
| | | | |
| | |>F29 200 OK ->| |
| | | |>F30 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F31<|
| | | | |
| | Bob makes a consultation call to Alice |
| | | | |
| | | |<---- PUBLISH F32<|
| | | | |
| | | |>F33 200 OK ----->|
| | | | |
| |<------------------------------------ INVITE F34<|
| | | | |
| |>F35 INVITE -->| | |
| | | | |
| |<-- 200 OK F36<| | |
| | | | |
| |>F37 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F38<|
| | | | |
| |>F39 ACK ----->| | |
| | | | |
| | |<======= RTP established =======>|
| | | | |
| | Bob hangs up with Alice |
| | | | |
| |<--------------------------------------- BYE F40<|
| | | | |
| |>F41 BYE ----->| | |
| | | | |
| |<-- 200 OK F42<| | |
<span class="grey">Johnston, et al. Standards Track [Page 53]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | | | |
| |>F43 200 OK ------------------------------------>|
| | | | |
| |<----------------------------(unhold) INVITE F44<|
|<- INVITE F45<| | | |
| | | | |
|>F46 200 OK ->| | | |
| |>F47 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F48<|
|<---- ACK F49<| | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F50<| |
| | | | |
| | |>F51 200 OK ->| |
| | | |>F52 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F53<|
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
Figure 9. Consultation Hold with Appearances Example
F32 Bob ----> Appearance Agent
PUBLISH sip:HelpDesk@example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bKa5d6cf61F5FBC05A
From: <sip:bob@example.com>;tag=44150CC6-A7B7919D
To: <sip:HelpDesk@example.com>;tag=428765950880801
CSeq: 11 PUBLISH
Call-ID: 44fwF144-F12893K38424
Contact: <sip:bob@ua2.example.com>
Event: dialog;shared
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="10"
state="full"
entity="sip:HelpDesk@example.com">
<dialog id="id3d4f9c83"
call-id="b3cbd0-ad2c5775e-5df9f8d5"
local-tag="3153DE7C-928203B"
<span class="grey">Johnston, et al. Standards Track [Page 54]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
direction="initiator">
<sa:exclusive>true</sa:exclusive>
<state>trying</state>
<local>
<target uri="sip:bob@ua2.example.com">
</target>
</local>
<remote>
<identity>sip:HelpDesk@example.com</identity>
<target uri="sip:alice@ua1.example.com" />
</remote>
</dialog>
</dialog-info>
<span class="h3"><a class="selflink" id="section-11.10" href="#section-11.10">11.10</a>. Joining or Bridging an Appearance</span>
In this call flow, a call answered by Bob is joined by Alice or
"bridged". The Join header field is used by Alice to request this
bridging. If Bob did not support media mixing, Bob could obtain
conferencing resources as described in [<a href="./rfc4579" title=""Session Initiation Protocol (SIP) Call Control - Conferencing for User Agents"">RFC4579</a>].
Carol Forking Proxy Appearance Agent Alice Bob
| | | | |
|<=============Both way RTP established===========>|
| | | | |
| | |< PUBLISH F22| |
| | | | |
| | |>F23 200 OK >| |
| | | | |
| |<---- INVITE (w/ Join) F24<| |
| | | | |
| |>F25 INVITE (w/Join)---------------->|
| | | | |
| |<---- OK 200 Contact:Bob;isfocus F26<|
| | | | |
| |< - - - - - >| | |
| | | | |
| | |>F27 NOTIFY >| |
| | | | |
| | |< 200 OK F28<| |
| | | | |
| | |>F29 NOTIFY ---------->|
| | | | |
| | |<F30 200 OK ----------<|
| | | | |
| |>F31 200 OK Contact:B----->| |
| | | | |
| |<----------------- ACK F32<| |
<span class="grey">Johnston, et al. Standards Track [Page 55]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | | | |
| |>ACK F33---------------------------->|
| | | | |
| |<-----INVITE Contact:Bob;isfocus F34<|
|<-INVITE F35| | | |
| | | | |
|>F26 200 -->| | | |
| |>F37 200 OK ------------------------>|
| | | | |
| |<--------------------------- ACK F38<|
|<--- ACK F39| | | |
| | | |<==RTP==>|
|<=============Both way RTP established===========>|
| | | | |
| |< - - - - - >| | |
| | | | |
| | |>F40 NOTIFY >| |
| | | | |
| | |< 200 OK F41<| |
| | | | |
| | |>F42 NOTIFY ---------->|
| | | | |
| | |<F43 200 OK ----------<|
| | | | |
Figure 10. Joining or Bridging an Appearance Example
F22 Alice ----> Appearance Agent
PUBLISH sip:HelpDesk@example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bKa5d6cf61F5FBC05A
From: <sip:alice@example.com>;tag=44150CC6-A7B7919D
To: <sip:HelpDesk@example.com>;tag=428765950880801
CSeq: 11 PUBLISH
Call-ID: 87837Fkw87asfds
Contact: <sip:alice@ua2.example.com>
Event: dialog;shared
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="10"
state="full"
entity="sip:HelpDesk@example.com:5060">
<dialog id="id3d4f9c83"
<span class="grey">Johnston, et al. Standards Track [Page 56]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
call-id="dc95da63-60db1abd-d5a74b48"
local-tag="605AD957-1F6305C2" >
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<sa:joined-dialog
call-id="14-1541707345"
from-tag="44BAD75D-E3128D42"
to-tag="d3b06488-1dd1-11b2-88c5-b03162323164+d3e48f4c" />
<state>trying</state>
<local>
<target uri="sip:alice@ua1.example.com">
</target>
</local>
<remote>
<target uri="sip:bob@example.com" />
</remote>
</dialog>
</dialog-info>
F24 Alice ----> Proxy
INVITE sip:bob@ua.example.com SIP/2.0
Via: SIP/2.0/UDP ua1.example.com;branch=z9hG4bKcc9d727c2C29BE31
From: <sip:HelpDesk@example.com>;tag=605AD957-1F6305C2
To: <sip:bob@ua.example.com>
CSeq: 2 INVITE
Call-ID: dc95da63-60db1abd-d5a74b48
Contact: <sip:alice@ua1.example.com>
<all-one-line>
Join: 14-1541707345;to-tag=d3b06488-1dd1-11b2-88c5
-b03162323164+d3e48f4c;from-tag=44BAD75D-E3128D42
</all-one-line>
Max-Forwards: 70
Content-Type: application/sdp
Content-Length: 223
v=0
o=- 1103061265 1103061265 IN IP4 ua1.example.com
s=IP SIP UA
c=IN IP4 ua1.example.com
t=0 0
a=sendrecv
m=audio 2236 RTP/AVP 0 8 101
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:101 telephone-event/8000
<span class="grey">Johnston, et al. Standards Track [Page 57]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h3"><a class="selflink" id="section-11.11" href="#section-11.11">11.11</a>. Loss of Appearance during Allocation</span>
Bob reserves an appearance with a PUBLISH, sends an INVITE to Carol,
then becomes unreachable. When he fails to refresh his publication
to the appearance agent, the Appearance Agent declares the dialog
terminated and frees up the appearance using NOTIFYs F14 and F16.
After retransmitting the NOTIFY to Bob (in not shown messages F17,
F18, etc.), the subscription is terminated.
Carol Proxy Alice Appearance Agent Bob
| | | | |
| | | |<----- PUBLISH F1<|
| | | | |
| | | |>F2 200 OK ------>|
| | | | |
| | |<-- NOTIFY F3<| |
| | | | |
| | |>F4 200 OK -->| |
| | | |------- NOTIFY F5>|
| | | | |
| | | |<F6 200 OK ------<|
| | | | |
| |<------------------------------------- INVITE F7<|
| | | | |
| |>F8 100 Trying --------------------------------->|
|<-- INVITE F9<| | | |
| | | |<---- PUBLISH F10<|
| | | | |
| | | |>F11 200 OK ----->|
| | | | |
|>F12 180 --->| | | |
| |>F13 180 Ringing ------------------------------->|
| | | | |
| | | | Bob goes offline |
| | | | |
| | | Appearance selection times out |
| | | | |
| | |<- NOTIFY F14<| |
| | | | |
| | |>F15 200 OK ->| |
| | | |------ NOTIFY F16>|
| | | | |
| | | NOTIFY is retransmitted |
Figure 11. Loss of Appearance during Allocation Example
<span class="grey">Johnston, et al. Standards Track [Page 58]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h3"><a class="selflink" id="section-11.12" href="#section-11.12">11.12</a>. Appearance Seizure Contention Race Condition</span>
Bob and Alice both try to reserve appearance 2 by publishing at the
same time. The Appearance Agent allocates the appearance to Bob by
sending a 200 OK and denies it to Alice by sending a 400 (Bad
Request) response. After the NOTIFY F5, Alice learns that Bob is
using appearance 2. Alice then attempts to reserve appearance 3 by
publishing, which is then accepted.
<span class="grey">Johnston, et al. Standards Track [Page 59]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Carol Proxy Alice Appearance Agent Bob
| | | | |
| | | |<----- PUBLISH F1<|
| | | | (appearance=2)
| | |>F2 PUBLISH ->| |
| | | (appearance=2) |
| | | | |
| | | |>F3 200 OK ------>|
| | |<---- F4 400 <| |
| | | | |
| | |<-- NOTIFY F5<| |
| | | | |
| | |>F6 200 OK -->| |
| | | |------- NOTIFY F7>|
| | | | |
| | | |<F8 200 OK ------<|
| | | | |
| |<------------------------------------- INVITE F9<|
| | | | |
| |>F10 100 Trying -------------------------------->|
|<- INVITE F11<| | | |
| | | |<---- PUBLISH F12<|
| | | | (appearance=2)
| | | |>F13 200 OK ----->|
| | |>F14 PUBLISH->| |
| | | (appearance=3) |
| | | | |
| | |<--- F15 200 <| |
| | | | |
| | |<- NOTIFY F16<| |
| | | | |
| | |>F17 200 OK ->| |
Dave | | |------ NOTIFY F18>|
| | | | |
| | | |<F19 200 OK -----<|
| |<-- INVITE F20<| | |
| | | | |
| |>F21 100 ----->| | |
|<- INVITE F22<| | | |
Figure 12. Appearance Seizure Contention Race Condition Example
<span class="h3"><a class="selflink" id="section-11.13" href="#section-11.13">11.13</a>. Appearance Agent Subscription to UAs</span>
In this scenario, the Appearance Agent does not have any way of
knowing Bob's dialog state information, except through Bob. This
could be because the Appearance Agent is not part of a B2BUA, or
<span class="grey">Johnston, et al. Standards Track [Page 60]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
perhaps Bob is remotely registering. When Bob registers, the
Appearance Agent receives a registration event package notification
from the registrar. The Appearance Agent then SUBSCRIBEs to Bob's
dialog event state using Event:dialog in the SUBSCRIBE. Whenever
Bob's dialog state changes, Bob's UA sends a NOTIFY to the Appearance
Agent which then notifies the other UAs in the group.
Carol Proxy Alice Appearance Agent Bob
| | | | |
| |<----------------------------------- REGISTER F1<|
| | | | |
| |>F2 200 OK ------------------------------------->|
| | | | |
| |>F3 NOTIFY ------------------>| |
| | | | |
| |<------------------ 200 OK F4<| |
| | | |---- SUBSCRIBE F5>|
| | | | |
| | | |<F6 200 OK ------<|
| | | | |
| | | |<------ NOTIFY F7<|
| | | | |
| | | |>F8 200 OK ------>|
| | | | |
| | | |<--- SUBSCRIBE F9<|
| | | | |
| | | |>F10 200 OK ----->|
| | | | |
| | | |------ NOTIFY F11>|
| | | | |
| | | |<F12 200 OK -----<|
| | | | |
| |<------------------------------------ INVITE F13<|
| | | | |
| |>F14 100 Trying -------------------------------->|
|<- INVITE F15<| | | |
| | | |<----- NOTIFY F16<|
| | | | |
| | | |>F17 200 OK ----->|
| | |<- NOTIFY F18<| |
| | | | |
| | |>F19 200 OK ->| |
| | | |------ NOTIFY F20>|
| | | | |
| | | |<F21 200 OK -----<|
|>F22 180 --->| | | |
| |>F23 180 Ringing ------------------------------->|
| | | | |
<span class="grey">Johnston, et al. Standards Track [Page 61]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | | |<----- NOTIFY F24<|
| | | | |
| | | |>F25 200 OK ----->|
| | |<- NOTIFY F26<| |
| | | | |
| | |>F27 200 OK ->| |
| | | |------ NOTIFY F28>|
| | | | |
| | | |<F29 200 OK -----<|
|>F30 200 OK ->| | | |
| |>F31 200 OK ------------------------------------>|
| | | | |
| | | |<----- NOTIFY F32<|
| | | | |
| | | |>F33 200 OK ----->|
| | | | |
| |<--------------------------------------- ACK F34<|
|<---- ACK F35<| | | |
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
| | |<- NOTIFY F36<| |
| | | | |
| | |>F37 200 OK ->| |
| | | |------ NOTIFY F38>|
| | | | |
| | | |<F39 200 OK -----<|
| | | | |
Figure 13. Appearance Agent Subscription to UAs Example
<span class="h3"><a class="selflink" id="section-11.14" href="#section-11.14">11.14</a>. Appearance Pickup Race Condition Failure</span>
In this scenario, Bob has an established dialog with Carol created
using the call flows of Figure 1 or Figure 2. Bob then places Carol
on hold. Alice receives a notification of this and renders this on
Alice's UI. Alice attempts to pick up the call but Carol hangs up
before the pickup can complete. Alice cancels the pickup attempt
with the PUBLISH F48. Note that the call flow for a failed Join
would be almost identical.
Carol Proxy Alice Appearance Agent Bob
| | | | |
|<================= Both way RTP established ===================>|
| | | | |
| |<------------------------------(hold) INVITE F22<|
|<- INVITE F23<| | | |
<span class="grey">Johnston, et al. Standards Track [Page 62]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | | | |
|>F24 200 OK ->| | | |
| |>F25 200 OK ------------------------------------>|
| | | | |
| |<--------------------------------------- ACK F26<|
|<---- ACK F27<| | | |
| | | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |<- NOTIFY F28<| |
| | | | |
| | |>F29 200 OK ->| |
| | | |>F30 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F31<|
| | | | |
| | Alice decides to pick up the call |
| | | | |
| | |>F32 PUBLISH->| |
| | | | |
| | |<- 200 OK F33<| |
| | | | |
| | |<- NOTIFY F34<| |
| | | | |
| | |>F35 200 OK ->| |
| | | |>F36 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F37<|
|>F38 BYE ---->| | | |
| |>F39 BYE --------------------------------------->|
| | | | |
| |<------------------------------------ OK 200 F40<|
|<- 200 OK F41<| | | |
| |<-- INVITE F42<| | |
|<- INVITE F43<|(w/ Replaces) | | |
|( w/ Replaces)| | | |
| | | | |
|>F44 481 ---->| | | |
| |>F45 481 ----->| | |
|<---- ACK F46<| | | |
| |<----- ACK F47<| | |
| | |>F48 PUBLISH->| |
| | | | |
| | |<- 200 OK F49<| |
| | | | |
| | |<- NOTIFY F50<| |
| | | | |
| | |>F51 200 OK ->| |
<span class="grey">Johnston, et al. Standards Track [Page 63]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
| | | |>F52 NOTIFY ----->|
| | | | |
| | | |<----- 200 OK F53<|
Figure 14. Appearance Pickup Race Condition Failure Example
F48 Alice ----> Appearance Agent
PUBLISH sip:HelpDesk@example.com SIP/2.0
Via: SIP/2.0/UDP ua2.example.com;branch=z9hG4bKa5d6cf61F5FBC05A
From: <sip:alice@example.com>;tag=44150CC6-A7B7919D
To: <sip:HelpDesk@example.com>;tag=428765950880801
CSeq: 11 PUBLISH
Call-ID: 87837Fkw87asfds
Contact: <sip:alice@ua2.example.com>
Event: dialog;shared
Max-Forwards: 70
Content-Type: application/dialog-info+xml
Content-Length: ...
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
xmlns:sa="urn:ietf:params:xml:ns:sa-dialog-info"
version="10"
state="full"
entity="sip:HelpDesk@example.com">
<dialog id="id3d4f9c83"
call-id="dc95da63-60db1abd-d5a74b48"
local-tag="605AD957-1F6305C2" >
<sa:appearance>1</sa:appearance>
<sa:exclusive>false</sa:exclusive>
<sa:replaced-dialog
call-id="14-1541707345"
from-tag="44BAD75D-E3128D42"
to-tag="d3b06488-1dd1-11b2-88c5-b03162323164+d3e48f4c" />
<state>terminated</state>
<local>
<target uri="sip:alice@ua1.example.com">
</target>
</local>
<remote>
<target uri="sip:carol@ua3.example.com" />
</remote>
</dialog>
</dialog-info>
<span class="grey">Johnston, et al. Standards Track [Page 64]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h3"><a class="selflink" id="section-11.15" href="#section-11.15">11.15</a>. Appearance Seizure Incoming/Outgoing Contention Race Condition</span>
Alice tries to seize appearance 2 at the same time appearance 2 is
allocated to an incoming call. The Appearance Agent resolves the
conflict by sending a 400 (Bad Request) to Alice. After the NOTIFY
F6, Alice learns that the incoming call is using appearance 2. Alice
republishes for appearance 3, which is accepted. Note that this
example shows the INVITE being received before the NOTIFY from the
Appearance Agent.
<span class="grey">Johnston, et al. Standards Track [Page 65]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Carol Proxy Alice Appearance Agent Bob
| | | | |
|>-- INVITE F1>| | | |
| |< - - - - - - - - - - - - - ->| |
| | | | |
| | |>F2 PUBLISH ->| |
| | | (appearance=2) |
| | | | |
| |>F3 INVITE (appearance=2) ---------------------->|
| | | | |
| |>F4 INVITE | | |
| |(appearance=2)>| | |
| | |<---- F5 400 <| |
| | | | |
| | |<-- NOTIFY F6<| |
| | | | |
| | |>F7 200 OK -->| |
| | | |------- NOTIFY F8>|
| | | | |
| | | |<F9 200 OK ------<|
| | | | |
| | |>F10 PUBLISH->| |
| | | (appearance=3) |
| | | | |
| | |< F11 200 OK <| |
| | | | |
| | |<- NOTIFY F12<| |
| | | | |
| |>F13 200 OK ->| |
Dave | | |------ NOTIFY F14>|
| | | | |
| | | |<F15 200 OK -----<|
| |<-- INVITE F16<| | |
| | | | |
| |>F17 100 ----->| | |
|<- INVITE F18<| | | |
Figure 15. Appearance Seizure Incoming/Outgoing Contention
Race Condition Example
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. Security Considerations</span>
Since multiple line appearance features are implemented using
semantics provided by SIP [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>], the SIP Event Package for Dialog
State [<a href="./rfc4235" title=""An INVITE- Initiated Dialog Event Package for the Session Initiation Protocol (SIP)"">RFC4235</a>], and the SIP Event Framework [<a href="./rfc6665" title=""SIP-Specific Event Notification"">RFC6665</a>] and [<a href="./rfc3903" title=""Session Initiation Protocol (SIP) Extension for Event State Publication"">RFC3903</a>],
security considerations in these documents apply to this document as
well.
<span class="grey">Johnston, et al. Standards Track [Page 66]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
To provide confidentiality, NOTIFY or PUBLISH message bodies that
provide the dialog state information and the dialog identifiers MAY
be encrypted end-to-end using the standard mechanisms such as S/MIME
described in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>]. Alternatively, sending the NOTIFY and
PUBLISH requests over TLS also provides confidentiality, although on
a hop-by-hop basis. All SUBSCRIBEs and PUBLISHes between the UAs and
the Appearance Agent MUST be authenticated. Without proper
authentication and confidentiality, a third party could learn
information about dialogs associated with a AOR and could try to use
this information to hijack or manipulate those dialogs using SIP call
control primitives.
This feature relies on standard SIP call control primitives such as
Replaces and Join. Proper access controls on their use MUST be used
so that only members of the shared appearance group can use these
mechanisms. All INVITEs with Replaces or Join header fields MUST
only be accepted if the peer requesting dialog replacement or joining
has been properly authenticated using a standard SIP mechanism (such
as Digest or S/MIME), and authorized to request a replacement.
Otherwise, a third party could disrupt or hijack existing dialogs in
the shared appearance group.
For an emergency call, a UA MUST NOT wait for a confirmed seizure of
an appearance before sending an INVITE. Waiting for confirmation
could inadvertently delay or block the emergency call, which by its
nature needs to be placed as expeditiously as possible. Instead, a
emergency call MUST proceed regardless of the status of the PUBLISH
transaction.
<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. IANA Considerations</span>
This section registers the SIP Event header field parameter 'shared',
the SIP Alert-Info header field parameter 'appearance', and the XML
namespace extensions to the SIP Dialog Package.
<span class="h3"><a class="selflink" id="section-13.1" href="#section-13.1">13.1</a>. SIP Event Header Field Parameter: shared</span>
This document defines the 'shared' header field parameter in the
Event header field in the "Header Field Parameters and Parameter
Values" registry defined by [<a href="./rfc3968" title=""The Internet Assigned Number Authority (IANA) Header Field Parameter Registry for the Session Initiation Protocol (SIP)"">RFC3968</a>].
Predefined
Header Field Parameter Name Values Reference
---------------------------- ------------------ ---------- ---------
Event shared No <a href="./rfc7463">RFC 7463</a>
<span class="grey">Johnston, et al. Standards Track [Page 67]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
<span class="h3"><a class="selflink" id="section-13.2" href="#section-13.2">13.2</a>. SIP Alert-Info Header Field Parameter: appearance</span>
This document defines the 'appearance' parameter in the Alert-Info
header in the "Header Field Parameters and Parameter Values" registry
defined by [<a href="./rfc3968" title=""The Internet Assigned Number Authority (IANA) Header Field Parameter Registry for the Session Initiation Protocol (SIP)"">RFC3968</a>].
Predefined
Header Field Parameter Name Values Reference
---------------------- --------------- --------- ---------
Alert-Info appearance No <a href="./rfc7463">RFC 7463</a>
<span class="h3"><a class="selflink" id="section-13.3" href="#section-13.3">13.3</a>. URN Sub-Namespace Registration: sa-dialog-info</span>
This section registers a new XML namespace per the procedures in
[<a href="./rfc3688" title=""The IETF XML Registry"">RFC3688</a>].
URI: urn:ietf:params:xml:ns:sa-dialog-info.
Registrant Contact: IETF BLISS working group, <bliss@ietf.org>,
Alan Johnston <alan.b.johnston@gmail.com>
XML:
BEGIN
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN"
"<a href="http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd</a>">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type"
content="text/html;charset=iso-8859-1"/>
<title>Shared Appearance Dialog Information Namespace</title>
</head>
<body>
<h1>Namespace for Shared Appearance Dialog Information</h1>
<h2>urn:ietf:params:xml:ns:sa-dialog-info</h2>
<p>See <a href="http://www.rfc-editor.org/rfc/rfc7463.txt">
<a href="./rfc7463">RFC 7463</a></a>.</p>
</body>
</html>
END
<span class="h3"><a class="selflink" id="section-13.4" href="#section-13.4">13.4</a>. XML Schema Registration</span>
This section registers an XML schema per the procedures in [<a href="./rfc3688" title=""The IETF XML Registry"">RFC3688</a>].
<span class="grey">Johnston, et al. Standards Track [Page 68]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
URI: urn:ietf:params:xml:schesa:sa-dialog-info.
Registrant Contact: IETF BLISS working group, <bliss@ietf.org>,
Alan Johnston <alan.b.johnston@gmail.com>
The XML for this schema can be found in <a href="#section-6">Section 6</a>.
<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. References</span>
<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997,
<<a href="http://www.rfc-editor.org/info/rfc2119">http://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC3261">RFC3261</a>] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
A., Peterson, J., Sparks, R., Handley, M., and E.
Schooler, "SIP: Session Initiation Protocol", <a href="./rfc3261">RFC 3261</a>,
June 2002, <<a href="http://www.rfc-editor.org/info/rfc3261">http://www.rfc-editor.org/info/rfc3261</a>>.
[<a id="ref-RFC3515">RFC3515</a>] Sparks, R., "The Session Initiation Protocol (SIP) Refer
Method", <a href="./rfc3515">RFC 3515</a>, April 2003,
<<a href="http://www.rfc-editor.org/info/rfc3515">http://www.rfc-editor.org/info/rfc3515</a>>.
[<a id="ref-RFC3688">RFC3688</a>] Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
January 2004, <<a href="http://www.rfc-editor.org/info/rfc3688">http://www.rfc-editor.org/info/rfc3688</a>>.
[<a id="ref-RFC3840">RFC3840</a>] Rosenberg, J., Schulzrinne, H., and P. Kyzivat,
"Indicating User Agent Capabilities in the Session
Initiation Protocol (SIP)", <a href="./rfc3840">RFC 3840</a>, August 2004,
<<a href="http://www.rfc-editor.org/info/rfc3840">http://www.rfc-editor.org/info/rfc3840</a>>.
[<a id="ref-RFC3891">RFC3891</a>] Mahy, R., Biggs, B., and R. Dean, "The Session Initiation
Protocol (SIP) "Replaces" Header", <a href="./rfc3891">RFC 3891</a>, September
2004, <<a href="http://www.rfc-editor.org/info/rfc3891">http://www.rfc-editor.org/info/rfc3891</a>>.
[<a id="ref-RFC3903">RFC3903</a>] Niemi, A., "Session Initiation Protocol (SIP) Extension
for Event State Publication", <a href="./rfc3903">RFC 3903</a>, October 2004,
<<a href="http://www.rfc-editor.org/info/rfc3903">http://www.rfc-editor.org/info/rfc3903</a>>.
[<a id="ref-RFC3911">RFC3911</a>] Mahy, R. and D. Petrie, "The Session Initiation Protocol
(SIP) "Join" Header", <a href="./rfc3911">RFC 3911</a>, October 2004,
<<a href="http://www.rfc-editor.org/info/rfc3911">http://www.rfc-editor.org/info/rfc3911</a>>.
<span class="grey">Johnston, et al. Standards Track [Page 69]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
[<a id="ref-RFC3968">RFC3968</a>] Camarillo, G., "The Internet Assigned Number Authority
(IANA) Header Field Parameter Registry for the Session
Initiation Protocol (SIP)", <a href="https://www.rfc-editor.org/bcp/bcp98">BCP 98</a>, <a href="./rfc3968">RFC 3968</a>, December
2004, <<a href="http://www.rfc-editor.org/info/rfc3968">http://www.rfc-editor.org/info/rfc3968</a>>.
[<a id="ref-RFC4235">RFC4235</a>] Rosenberg, J., Schulzrinne, H., and R. Mahy, "An INVITE-
Initiated Dialog Event Package for the Session Initiation
Protocol (SIP)", <a href="./rfc4235">RFC 4235</a>, November 2005,
<<a href="http://www.rfc-editor.org/info/rfc4235">http://www.rfc-editor.org/info/rfc4235</a>>.
[<a id="ref-RFC5234">RFC5234</a>] Crocker, D. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, <a href="./rfc5234">RFC 5234</a>, January 2008,
<<a href="http://www.rfc-editor.org/info/rfc5234">http://www.rfc-editor.org/info/rfc5234</a>>.
[<a id="ref-RFC6665">RFC6665</a>] Roach, A., "SIP-Specific Event Notification", <a href="./rfc6665">RFC 6665</a>,
July 2012, <<a href="http://www.rfc-editor.org/info/rfc6665">http://www.rfc-editor.org/info/rfc6665</a>>.
[<a id="ref-RFC7462">RFC7462</a>] Liess, L., Ed., Jesske, R., Johnston, A., Worley, D., and
P. Kyzivat, "URNs for the Alert-Info Header Field of the
Session Initiation Protocol (SIP)", <a href="./rfc7462">RFC 7462</a>, March 2015,
<<a href="http://www.rfc-editor.org/info/rfc7462">http://www.rfc-editor.org/info/rfc7462</a>>.
<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>. Informative References</span>
[<a id="ref-RFC3680">RFC3680</a>] Rosenberg, J., "A Session Initiation Protocol (SIP) Event
Package for Registrations", <a href="./rfc3680">RFC 3680</a>, March 2004,
<<a href="http://www.rfc-editor.org/info/rfc3680">http://www.rfc-editor.org/info/rfc3680</a>>.
[<a id="ref-RFC4579">RFC4579</a>] Johnston, A. and O. Levin, "Session Initiation Protocol
(SIP) Call Control - Conferencing for User Agents", <a href="https://www.rfc-editor.org/bcp/bcp119">BCP</a>
<a href="https://www.rfc-editor.org/bcp/bcp119">119</a>, <a href="./rfc4579">RFC 4579</a>, August 2006,
<<a href="http://www.rfc-editor.org/info/rfc4579">http://www.rfc-editor.org/info/rfc4579</a>>.
[<a id="ref-RFC5359">RFC5359</a>] Johnston, A., Sparks, R., Cunningham, C., Donovan, S., and
K. Summers, "Session Initiation Protocol Service
Examples", <a href="https://www.rfc-editor.org/bcp/bcp144">BCP 144</a>, <a href="./rfc5359">RFC 5359</a>, October 2008,
<<a href="http://www.rfc-editor.org/info/rfc5359">http://www.rfc-editor.org/info/rfc5359</a>>.
[<a id="ref-RFC7088">RFC7088</a>] Worley, D., "Session Initiation Protocol Service Example
-- Music on Hold", <a href="./rfc7088">RFC 7088</a>, February 2014,
<<a href="http://www.rfc-editor.org/info/rfc7088">http://www.rfc-editor.org/info/rfc7088</a>>.
<span class="grey">Johnston, et al. Standards Track [Page 70]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Acknowledgements
The following individuals were part of the shared appearance design
team and have provided input and text to the document (in
alphabetical order):
Martin Dolly, Andrew Hutton, Raj Jain, Fernando Lombardo, Derek
MacDonald, Bill Mitchell, Michael Procter, and Theo Zourzouvillys.
Thanks to Chris Boulton for helping with the XML schema.
Much of the material has been drawn from previous work by Mohsen
Soroushnejad, Venkatesh Venkataramanan, Paul Pepper, and Anil Kumar,
who in turn received assistance from:
Kent Fritz, John Weald, and Sunil Veluvali of Sylantro Systems;
Steve Towlson and Michael Procter of Citel Technologies; Rob
Harder and Hong Chen of Polycom, Inc.; John Elwell and JD Smith of
Siemens Communications; Dale R. Worley of Pingtel; and Graeme
Dollar of Yahoo, Inc.
Also thanks to Geoff Devine, Paul Kyzivat, Jerry Yin, John Elwell,
Dan York, Spenser Dawkins, Martin Dolly, and Brett Tate for their
comments.
Thanks to Carolyn Beeton, Francois Audet, Andy Hutton, Tim Ross, Raji
Chinnappa, and Harsh Mendiratta for their detailed review of the
document.
Authors' Addresses
Alan Johnston (editor)
Avaya
St. Louis, MO
United States
EMail: alan.b.johnston@gmail.com
Mohsen Soroushnejad (editor)
Sylantro Systems Corp.
EMail: msoroush@gmail.com
<span class="grey">Johnston, et al. Standards Track [Page 71]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
<span class="grey"><a href="./rfc7463">RFC 7463</a> SIP Shared Appearances March 2015</span>
Venkatesh Venkataramanan
Sylantro Systems Corp.
EMail: vvenkatar@gmail.com
Johnston, et al. Standards Track [Page 72]
</pre>
|